Chilkat Online Tools

delphiAx / Zoom API / Update an IM directory group

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
req: TChilkatHttpRequest;
resp: IChilkatHttpResponse;
respStatusCode: Integer;

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

http := TChilkatHttp.Create(Self);

req := TChilkatHttpRequest.Create(Self);
req.HttpVerb := 'PATCH';
req.Path := '/v2/im/groups/:groupId';
req.ContentType := 'multipart/form-data';
req.AddParam('anim Duis adipisicing sint','');

req.AddStringForUpload2('','','','','anim Duis adipisicing sintrestricted');

req.AddParam('search_by_domain','anim Duis adipisicing sintrestrictedfalse');

req.AddParam('search_by_account','anim Duis adipisicing sintrestrictedfalsetrue');

req.AddParam('search_by_ma_account','anim Duis adipisicing sintrestrictedfalsetruefalse');

req.AddHeader('Authorization','Bearer <access_token>');

resp := http.SynchronousRequest('api.zoom.us',443,1,req.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode <> 204) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(resp.BodyStr);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

Memo1.Lines.Add('Success.');

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'name=anim Duis adipisicing sint'
	--form 'type=anim Duis adipisicing sintrestricted'
	--form 'search_by_domain=anim Duis adipisicing sintrestrictedfalse'
	--form 'search_by_account=anim Duis adipisicing sintrestrictedfalsetrue'
	--form 'search_by_ma_account=anim Duis adipisicing sintrestrictedfalsetruefalse'
https://api.zoom.us/v2/im/groups/:groupId

Postman Collection Item JSON

{
  "name": "Update an IM directory group",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "name",
          "value": "anim Duis adipisicing sint",
          "description": "Group name: must be unique to one account.",
          "type": "text"
        },
        {
          "key": "type",
          "value": "restricted",
          "description": "IM Group types:<br>`normal` - Only group members can automatically see others in their group. Other people can search for members in the group.<br>`shared` - Everyone under the account can see the group and members automatically.<br>`restricted` - Nobody can see the group or search for members except for the members in the group. (This can only be one of normal,shared,restricted)",
          "type": "text"
        },
        {
          "key": "search_by_domain",
          "value": "false",
          "description": "Members can search for others in the same email domain.",
          "type": "text"
        },
        {
          "key": "search_by_account",
          "value": "true",
          "description": "Members can search for others under same account.",
          "type": "text"
        },
        {
          "key": "search_by_ma_account",
          "value": "false",
          "description": "Members can search for others under same master account, including all sub accounts.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/im/groups/:groupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "im",
        "groups",
        ":groupId"
      ],
      "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": "Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>\n**Scopes**: `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204` <br>\nIM group updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "anim Duis adipisicing sint",
              "description": "Group name: must be unique to one account.",
              "type": "text"
            },
            {
              "key": "type",
              "value": "restricted",
              "description": "IM Group types:<br>`normal` - Only group members can automatically see others in their group. Other people can search for members in the group.<br>`shared` - Everyone under the account can see the group and members automatically.<br>`restricted` - Nobody can see the group or search for members except for the members in the group. (This can only be one of normal,shared,restricted)",
              "type": "text"
            },
            {
              "key": "search_by_domain",
              "value": "false",
              "description": "Members can search for others in the same email domain.",
              "type": "text"
            },
            {
              "key": "search_by_account",
              "value": "true",
              "description": "Members can search for others under same account.",
              "type": "text"
            },
            {
              "key": "search_by_ma_account",
              "value": "false",
              "description": "Members can search for others under same master account, including all sub accounts.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId"
          ],
          "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": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**Error Code:** `300` <br>\nMissing field: name",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "anim Duis adipisicing sint",
              "description": "Group name: must be unique to one account.",
              "type": "text"
            },
            {
              "key": "type",
              "value": "restricted",
              "description": "IM Group types:<br>`normal` - Only group members can automatically see others in their group. Other people can search for members in the group.<br>`shared` - Everyone under the account can see the group and members automatically.<br>`restricted` - Nobody can see the group or search for members except for the members in the group. (This can only be one of normal,shared,restricted)",
              "type": "text"
            },
            {
              "key": "search_by_domain",
              "value": "false",
              "description": "Members can search for others in the same email domain.",
              "type": "text"
            },
            {
              "key": "search_by_account",
              "value": "true",
              "description": "Members can search for others under same account.",
              "type": "text"
            },
            {
              "key": "search_by_ma_account",
              "value": "false",
              "description": "Members can search for others under same master account, including all sub accounts.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId"
          ],
          "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.\n**Error Code:** `4130`<br>\nGroup does not exist:{groupId}.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "anim Duis adipisicing sint",
              "description": "Group name: must be unique to one account.",
              "type": "text"
            },
            {
              "key": "type",
              "value": "restricted",
              "description": "IM Group types:<br>`normal` - Only group members can automatically see others in their group. Other people can search for members in the group.<br>`shared` - Everyone under the account can see the group and members automatically.<br>`restricted` - Nobody can see the group or search for members except for the members in the group. (This can only be one of normal,shared,restricted)",
              "type": "text"
            },
            {
              "key": "search_by_domain",
              "value": "false",
              "description": "Members can search for others in the same email domain.",
              "type": "text"
            },
            {
              "key": "search_by_account",
              "value": "true",
              "description": "Members can search for others under same account.",
              "type": "text"
            },
            {
              "key": "search_by_ma_account",
              "value": "false",
              "description": "Members can search for others under same master account, including all sub accounts.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/im/groups/:groupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "im",
            "groups",
            ":groupId"
          ],
          "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": ""
    }
  ]
}