Logo
Zoom Public API Documentation

Update a user

PATCH {{baseUrl}}/users/:userId?login_type=99&remove_tsp_credentials=<boolean>

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

Scopes: user:write:admin,user:write

Rate Limit Label: LIGHT

 

Body PARAM

Key Datatype Required Description 
login_type
number The user's login method. * `0` - Facebook OAuth. * `1` - Google OAuth. * `24` - Apple OAuth. * `27` - Microsoft OAuth. * `97` - Mobile device. * `98` - RingCentral OAuth. * `99` - API user. * `100` - Zoom Work email. * `101` - Single Sign-On (SSO). These login methods are only available in China. * `11` - Phone number. * `21` - WeChat. * `23` - Alipay.
remove_tsp_credentials
string Whether to remove the user's TSP credentials. * `true` - The queried ID is an employee's unique ID. * `false` - The queried ID is not an employee's unique ID. This value defaults to `false` (null).



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status





Curl
curl -X PATCH 'https://api.zoom.us/v2/users/:userId?login_type=99&remove_tsp_credentials=<boolean>?login_type=99&remove_tsp_credentials=<boolean>' -H 'Content-Type: application/json' -d '{"cms_user_id":"\u003cstring\u003e","company":"\u003cstring\u003e","custom_attributes":[{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"dept":"\u003cstring\u003e","first_name":"\u003cstring\u003e","group_id":"\u003cstring\u003e","host_key":"\u003cstring\u003e","job_title":"\u003cstring\u003e","language":"\u003cstring\u003e","last_name":"\u003cstring\u003e","location":"\u003cstring\u003e","manager":"\u003cemail\u003e","phone_country":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","phone_numbers":[{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Office","number":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Mobile","number":"\u003cstring\u003e"}],"pmi":"\u003cinteger\u003e","pronouns":"\u003cstring\u003e","pronouns_option":3,"timezone":"\u003cstring\u003e","type":99,"use_pmi":false,"vanity_name":"\u003cstring\u003e","display_name":"\u003cstring\u003e","zoom_one_type":128,"plan_united_type":"8192","feature":{"zoom_phone":"\u003cboolean\u003e"},"about_me":"\u003cstring\u003e","linkedin_url":"\u003cstring\u003e"}'

ENDPOINTS