POST /users

A Zoom account can have one or more users. Use this API to add a new user to your account.

Prerequisites:

Pro or higher plan

Scopes: user:write:admin user:write

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
`user_info`	Object	No
`user_info.email`	String	Yes	User email address.
`user_info.last_name`	String	No	User's last name: cannot contain more than 5 Chinese words.
`user_info.first_name`	String	No	User's first name: cannot contain more than 5 Chinese words.
`user_info.password`	String	No	User password. Only used for the "autoCreate" function. The password has to have a minimum of 8 characters and maximum of 32 characters. By default (basic requirement), password must have at least one letter (a, b, c..), at least one number (1, 2, 3...) and include both uppercase and lowercase letters. It should not contain only one identical character repeatedly ('11111111' or 'aaaaaaaa') and it cannot contain consecutive characters ('12345678' or 'abcdefgh'). 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.
`user_info.type`	Integer	Yes	User type: `1` - Basic. `2` - Licensed. `3` - On-prem. `99` - None (this can only be set with `ssoCreate`). Valid values: `99` `1` `2` `3`
`action`	String	Yes	Specify how to create the new user: `create` - User will get an email sent from Zoom. There is a confirmation link in this email. The user will then need to use the link to activate their Zoom account. The user can then set or change their password. `autoCreate` - This action is provided for the enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain. `custCreate` - Users created via this option do not have passwords and will not have the ability to log into the Zoom Web Portal or the Zoom Client. These users can still host and join meetings using the `start_url` and `join_url` respectively. To use this option, you must contact the ISV Platform Sales team at isv@zoom.us. `ssoCreate` - This action is provided for the enabled “Pre-provisioning SSO User” option. A user created in this way has no password. If not a basic user, a personal vanity URL using the user name (no domain) of the provisioning email will be generated. If the user name or PMI is invalid or occupied, it will use a random number or random personal vanity URL. Valid values: `"create"` `"custCreate"` `"autoCreate"` `"ssoCreate"`

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.