Update a user

PATCH

/users/{userId}

Users

Update information on a user's Zoom profile.

Scopes: user:write:admin user:write

Rate Limit Label: Light

响应示例

204 - 示例 1

{}

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query 参数

login_type

enum<string>

可选

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

枚举值:

0199100101

Body 参数multipart/form-data

cms_user_id

string

可选

Kaltura user ID.

company

string

可选

User's company.

<= 255 字符

custom_attributes

object

可选

Custom attribute(s) of the user.

key

string

可选

Identifier for the custom attribute.

name

string

可选

Name of the custom attribute.

value

string

可选

Value of the custom attribute.

dept

string

可选

Department for user profile: use for report.

first_name

string

可选

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

<= 64 字符

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.

host_key

string

可选

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

>= 6 字符<= 10 字符

job_title

string

可选

User's job title.

<= 128 字符

language

string

language

可选

last_name

string

可选

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

<= 64 字符

location

string

可选

User's location.

<= 256 字符

manager

string <email>

可选

The manager for the user.

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.

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_numbers

object

可选

code

string

可选

Country code of the phone number. For example, for United States phone numbers, the value of this field should be "+1".

country

string

可选

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.

number

string

可选

Phone number of the user.

pmi

integer

可选

Personal meeting ID: length must be 10.

timezone

string

可选

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

type

enum<integer>

可选

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

枚举值:

12399

use_pmi

boolean

可选

Use Personal Meeting ID for instant meetings.

默认值:

false

示例值:

false

vanity_name

string

可选

Personal meeting room name.

返回响应

🟢204**HTTP Status Code:** `204` User updated.

application/json

Body

object {0}

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` A Zoom Room user cannot be updated to a free user type: $userId **Error Code:**`300` Your request could not be completed because the name contains an invalid word: {n

🟠404**HTTP Status Code:** `404` **Error Code:** `1001` User does not exist: $userId.

Get a user

Delete user assistants