delphiDll / Zoom API / Update role information
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'PATCH');
CkHttpRequest_putPath(req,'/v2/roles/:roleId');
CkHttpRequest_putContentType(req,'multipart/form-data');
CkHttpRequest_AddParam(req,'id','do Lorem est dolore');
CkHttpRequest_AddParam(req,'do Lorem est doloreUt ipsum adipisicing eu','');
CkHttpRequest_AddParam(req,'description','do Lorem est doloreUt ipsum adipisicing euincididunt');
CkHttpRequest_AddParam(req,'total_members','do Lorem est doloreUt ipsum adipisicing euincididunt-75613664');
CkHttpRequest_AddParam(req,'privileges','do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]');
CkHttpRequest_AddParam(req,'sub_account_privileges','do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]{"second_level":-31284422}');
CkHttpRequest_AddHeader(req,'Authorization','Bearer <access_token>');
resp := CkHttp_SynchronousRequest(http,'api.zoom.us',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'id=do Lorem est dolore'
--form 'name=do Lorem est doloreUt ipsum adipisicing eu'
--form 'description=do Lorem est doloreUt ipsum adipisicing euincididunt'
--form 'total_members=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664'
--form 'privileges=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]'
--form 'sub_account_privileges=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]{"second_level":-31284422}'
https://api.zoom.us/v2/roles/:roleId
Postman Collection Item JSON
{
"name": "Update role information",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "do Lorem est dolore",
"description": "Role Id.",
"type": "text"
},
{
"key": "name",
"value": "Ut ipsum adipisicing eu",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "incididunt",
"description": "Description of the role.",
"type": "text"
},
{
"key": "total_members",
"value": "-75613664",
"description": "Total members assigned to that role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"elit veniam tempor\",\"anim laboris Excepteur\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).\n",
"type": "text"
},
{
"key": "sub_account_privileges",
"value": "{\"second_level\":-31284422}",
"description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles/:roleId",
"host": [
"{{baseUrl}}"
],
"path": [
"roles",
":roleId"
],
"variable": [
{
"key": "roleId",
"value": "quis officia in reprehenderit",
"description": "(Required) Role Id"
}
]
},
"description": "Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to change the privileges, name and description of a specific role.<br>\n**Pre-requisite:**<br>\n* A Pro or higher plan.<br>\n* For role management and updates, you must be the Account Owner or user with role management permissions.<br>**Scopes:** `role:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**Error Code:** `200`<br>\nThe account must be a paid account to update the role.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "dolore est",
"description": "Role Id.",
"type": "text"
},
{
"key": "name",
"value": "enim esse",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "elit veniam",
"description": "Description of the role.",
"type": "text"
},
{
"key": "total_members",
"value": "-91821999",
"description": "Total members assigned to that role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).\n",
"type": "text"
},
{
"key": "sub_account_privileges",
"value": "{\"second_level\":96157102}",
"description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles/:roleId",
"host": [
"{{baseUrl}}"
],
"path": [
"roles",
":roleId"
],
"variable": [
{
"key": "roleId",
"value": "quis officia in reprehenderit",
"description": "(Required) Role Id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**Status Code:** `400`<br>\nRole updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "dolore est",
"description": "Role Id.",
"type": "text"
},
{
"key": "name",
"value": "enim esse",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "elit veniam",
"description": "Description of the role.",
"type": "text"
},
{
"key": "total_members",
"value": "-91821999",
"description": "Total members assigned to that role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).\n",
"type": "text"
},
{
"key": "sub_account_privileges",
"value": "{\"second_level\":96157102}",
"description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles/:roleId",
"host": [
"{{baseUrl}}"
],
"path": [
"roles",
":roleId"
],
"variable": [
{
"key": "roleId",
"value": "quis officia in reprehenderit",
"description": "(Required) Role Id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**Error Code:** `300`\nThis role cannot be updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "id",
"value": "dolore est",
"description": "Role Id.",
"type": "text"
},
{
"key": "name",
"value": "enim esse",
"description": "Name of the role.",
"type": "text"
},
{
"key": "description",
"value": "elit veniam",
"description": "Description of the role.",
"type": "text"
},
{
"key": "total_members",
"value": "-91821999",
"description": "Total members assigned to that role.",
"type": "text"
},
{
"key": "privileges",
"value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
"description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).\n",
"type": "text"
},
{
"key": "sub_account_privileges",
"value": "{\"second_level\":96157102}",
"description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/roles/:roleId",
"host": [
"{{baseUrl}}"
],
"path": [
"roles",
":roleId"
],
"variable": [
{
"key": "roleId",
"value": "quis officia in reprehenderit",
"description": "(Required) Role Id"
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
