Create a sub account

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/accounts' \
--form 'email=""' \
--form 'first_name=""' \
--form 'last_name=""' \
--form 'password=""'

响应示例

201 - response

{
    "created_at": "string",
    "id": "string",
    "owner_email": "string",
    "owner_id": "string"
}

请求参数

Body 参数multipart/form-data

account_name

string

可选

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".

<= 64 字符

string

必需

User's email address.

<= 128 字符

first_name

string

必需

User's first name.

<= 64 字符

last_name

string

必需

User's last name.

<= 64 字符

options

object

可选

Account options object.

billing_auto_renew

boolean

可选

Toggle whether automatic billing renewal is on or off.

meeting_connector_list

array[string]

可选

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 share_mc is set to true.

pay_mode

enum<string>

可选

Payee:
master - master account holder pays.
sub - Sub account holder pays.

枚举值:

mastersub

默认值:

master

room_connector_list

array[string]

可选

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 share_rc is set to true.

share_mc

boolean

可选

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.

默认值:

false

share_rc

boolean

可选

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.

默认值:

false

password

string

必需

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 password_requirement field present in the security object.

返回响应

🟢201Account created.

application/json

Body

created_at

string

可选

Account created date time.

string

可选

Account ID.

owner_email

string

可选

Account owner email.

owner_id

string

可选

Account owner ID.

🟠400**HTTP Status Code:** `400` **Error Code:**`300` Your request could not be completed because the name contains an invalid word: {name} **Error Code:** `1107` Email domain is blocked. **Error Code:** `1111` Password should not contain r

🟠409**HTTP Status Code:** `409` **Error Code:** `1005` Email $email has already been used.

修改于 2024-04-24 09:06:48

List sub accounts

Disassociate a sub account