Chilkat Online Tools

Objective-C / Zoom API / Add IM directory group members

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonArray.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/v2/im/groups/:groupId/members";
req.ContentType = @"multipart/form-data";

CkoJsonArray *jsonFormData1 = [[CkoJsonArray alloc] init];

[jsonFormData1 AddObjectAt: [NSNumber numberWithInt: -1]];
CkoJsonObject *jsonObj_1 = [jsonFormData1 ObjectAt: [NSNumber numberWithInt: ([jsonFormData1.Size intValue] - 1)]];
[jsonObj_1 UpdateString: @"id" value: @"id do sunt"];
[jsonObj_1 UpdateString: @"email" value: @"exercitation"];

[jsonFormData1 AddObjectAt: [NSNumber numberWithInt: -1]];
jsonObj_1 = [jsonFormData1 ObjectAt: [NSNumber numberWithInt: ([jsonFormData1.Size intValue] - 1)]];
[jsonObj_1 UpdateString: @"id" value: @"sed aliqua sunt"];
[jsonObj_1 UpdateString: @"email" value: @"quis"];

[req AddParam: @"members" value: [jsonFormData1 Emit]];

[req AddHeader: @"Authorization" value: @"Bearer <access_token>"];

CkoHttpResponse *resp = [http SynchronousRequest: @"api.zoom.us" port: [NSNumber numberWithInt: 443] ssl: YES req: req];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'members=[{"id":"id do sunt","email":"exercitation"},{"id":"sed aliqua sunt","email":"quis"}]'
https://api.zoom.us/v2/im/groups/:groupId/members

Postman Collection Item JSON

{
  "name": "Add IM directory group members",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "members",
          "value": "[{\"id\":\"id do sunt\",\"email\":\"exercitation\"},{\"id\":\"sed aliqua sunt\",\"email\":\"quis\"}]",
          "description": "List of IM group members.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/im/groups/:groupId/members",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "im",
        "groups",
        ":groupId",
        "members"
      ],
      "variable": [
        {
          "key": "groupId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
        }
      ]
    },
    "description": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>\n**Scope:** `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**Error Code:** `200` <br>\nOnly available for paid account:{accountId}.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
              "description": "List of IM group members.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId",
            "members"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `201` <br>\nMember added.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
              "description": "List of IM group members.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId",
            "members"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"ids\": \"string\",\n \"added_at\": \"string [date-time]\"\n}"
    },
    {
      "name": "**Error Code:** `300` <br>\nMissing field: name.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
              "description": "List of IM group members.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId",
            "members"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404` <br>\nIM Group not found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
              "description": "List of IM group members.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId",
            "members"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}