POST /accounts
Create a sub account under a master account. Your account must be a master account in order to create sub accounts.
Zoom allows only approved partners to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us. for more details. Please note that the created account user will receive a confirmation email.
Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope: account:write:admin
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
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 |
|---|---|---|---|
email |
String | Yes |
User's email address. |
last_name |
String | Yes |
User's last name. |
options |
Object | No |
Account options object. |
options.share_mc |
Boolean | No |
Enable/disable the option for a sub account to use shared Meeting Connector(s) that are set up by the master account. Meeting Connectors can only be used by On-prem users. Default value: false |
options.meeting_connector_list[] |
Array | No |
Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account. Note: This option can only be used if the value of |
options.billing_auto_renew |
Boolean | No |
Toggle whether automatic billing renewal is on or off. |
options.pay_mode |
String | No |
Payee: Valid values:
Default value: "master" |
options.room_connector_list[] |
Array | No |
Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account. Note: This option can only be used if the value of |
options.share_rc |
Boolean | No |
Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users. Default value: false |
account_name |
String | No |
Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of "first_name" and "last_name". |
first_name |
String | Yes |
User's first name. |
password |
String | Yes |
User's password. Note: If the account owner or admin has enabled enhanced password requirements, the value provided in this field must meet those requirements. These requirements can be retrieved by calling the Get Account Settings API and referring to the |
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.