Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Phone Dashboard
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
patch

/users/{userId}

Update information on a user’s Zoom profile. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:write:admin user:write
Rate Limit Label: Light

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Request Body

User

1 Example
Schema
object

The user update object represents a user on Zoom.

first_name
string

User’s first name. Cannot contain more than 5 Chinese characters.

1 validation
last_name
string

User’s last name. Cannot contain more than 5 Chinese characters.

1 validation
type
integer

User types:
1 - Basic.
2 - Licensed.
3 - On-prem.
99 - None (this can only be set with ssoCreate).

1 validation
pmi
integer

Personal meeting ID: length must be 10.

2 validations
use_pmi
boolean

Use Personal Meeting ID for instant meetings.

1 validation
timezone
string

The time zone ID for a user profile. For this parameter value please refer to the ID value in the timezone list.

language
string

language

dept
string

Department for user profile: use for report.

vanity_name
string

Personal meeting room name.

host_key
string

Host key. It should be a 6-10 digit number.

2 validations
cms_user_id
string

Kaltura user ID.

job_title
string

User’s job title.

1 validation
company
string

User’s company.

1 validation
location
string

User’s location.

1 validation
phone_number
string

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.

phone_country
string

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.

custom_attributes
object

Custom attribute(s) of the user.

group_id
string

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.

phone_numbers
object
manager
string

The manager for the user.

1 validation
pronouns
string

The user’s pronouns.

pronouns_option
integer

The user’s display pronouns setting:

  • 1 — Ask the user every time they join meetings and webinars.
  • 2 — Always display pronouns in meetings and webinars.
  • 3 — Do not display pronouns in meetings and webinars.
1 validation

Responses

HTTP Status Code: 204
User updated.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
userId
$$.env
1 variable not set
oauth_access_token