PATCH /roles/{roleId}
Each Zoom user automatically has a role 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.
Use this API to change the privileges, name and description of a specific role.
Pre-requisite:
- A Pro or higher plan.
- For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes:role:write:admin
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
roleId |
String | Yes |
Role Id |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Role Id. |
name |
String | No |
Name of the role. |
description |
String | No |
Description of the role. |
privileges[] |
Array | No |
Privileges assigned to the role. Can be one or a combination of these permissions. |
total_members |
Integer | No |
Total members assigned to that role. |
sub_account_privileges |
Object | No |
This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure. |
sub_account_privileges.second_level |
Integer | No |
Indicates how the account can manage sub accounts. The value can be one of the following: |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.