PATCH /users/{userId}

Update information on a user's Zoom profile.

Scopes: user:write:admin user:write

Rate Limit Label: Light

Servers

https://api.zoom.us/v2

Path parameters

Name	Type	Required	Description
`userId`	String	Yes	The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`login_type`	String	No	`0` - Facebook. `1` - Google. `99` - API. `100` - Zoom. `101` - SSO. Valid values: `"99"` `"1"` `"0"` `"101"` `"100"`

login_type

String

0 - Facebook.
1 - Google.
99 - API.
100 - Zoom.
101 - SSO.

Valid values:

"99"
"1"
"0"
"101"
"100"

Request body fields

Name	Type	Required	Description
`job_title`	String	No	User's job title.
`pmi`	Integer	No	Personal meeting ID: length must be 10.
`location`	String	No	User's location.
`phone_country`	String	No	Note: This field has been deprecated and will not be supported in the future. Use the country field of the phone_numbers object instead to select the country for the phone number. Country ID of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.
`phone_numbers`	Object	No
`phone_numbers.number`	String	No	Phone number of the user.
`phone_numbers.code`	String	No	Country code of the phone number. For example, for United States phone numbers, the value of this field should be "+1".
`phone_numbers.country`	String	No	Country ID of the phone number. For example, if the phone number provided in the `number` field is a Brazil based number, the value of the `country` field should be `BR`.
`host_key`	String	No	Host key. It should be a 6-10 digit number.
`first_name`	String	No	User's first name. Cannot contain more than 5 Chinese characters.
`vanity_name`	String	No	Personal meeting room name.
`manager`	String	No	The manager for the user.
`phone_number`	String	No	Note: This field has been deprecated and will not be supported in the future. Use the phone_numbers field instead to assign phone number(s) to a user. Phone number of the user. To update a phone number, you must also provide the `phone_country` field.
`cms_user_id`	String	No	Kaltura user ID.
`custom_attributes`	Object	No	Custom attribute(s) of the user.
`custom_attributes.name`	String	No	Name of the custom attribute.
`custom_attributes.key`	String	No	Identifier for the custom attribute.
`custom_attributes.value`	String	No	Value of the custom attribute.
`timezone`	String	No	The time zone ID for a user profile. For this parameter value please refer to the ID value in the timezone list.
`last_name`	String	No	User's last name. Cannot contain more than 5 Chinese characters.
`company`	String	No	User's company.
`dept`	String	No	Department for user profile: use for report.
`type`	Integer	No	User types: `1` - Basic. `2` - Licensed. `3` - On-prem. `99` - None (this can only be set with `ssoCreate`). Valid values: `99` `1` `2` `3`
`use_pmi`	Boolean	No	Use Personal Meeting ID for instant meetings. Default value: false
`group_id`	String	No	Provide unique identifier of the group that you would like to add a pending user to. The value of this field can be retrieved from List Groups API.
`language`	String	No	language

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.