DataFlex / Zoom API / Update role information
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "PATCH"
Set ComPath Of hoReq To "/v2/roles/:roleId"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "id" "do Lorem est dolore"
Send ComAddParam To hoReq "do Lorem est doloreUt ipsum adipisicing eu" ""
Send ComAddParam To hoReq "description" "do Lorem est doloreUt ipsum adipisicing euincididunt"
Send ComAddParam To hoReq "total_members" "do Lorem est doloreUt ipsum adipisicing euincididunt-75613664"
Send ComAddParam To hoReq "privileges" 'do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]'
Send ComAddParam To hoReq "sub_account_privileges" 'do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]{"second_level":-31284422}'
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "api.zoom.us" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
End_Procedure
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": ""
}
]
}
