SQL Server / Zoom API / Update role information
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @req int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'PATCH'
EXEC sp_OASetProperty @req, 'Path', '/v2/roles/:roleId'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'id', 'do Lorem est dolore'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'do Lorem est doloreUt ipsum adipisicing eu', ''
EXEC sp_OAMethod @req, 'AddParam', NULL, 'description', 'do Lorem est doloreUt ipsum adipisicing euincididunt'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'total_members', 'do Lorem est doloreUt ipsum adipisicing euincididunt-75613664'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'privileges', 'do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'sub_account_privileges', 'do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]{"second_level":-31284422}'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
