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

Request Params

KeyDatatypeRequiredDescription
login_typenumberThe 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). |

Request Body

{"cms_user_id"=>"<string>", "company"=>"<string>", "custom_attributes"=>[{"key"=>"<string>", "name"=>"<string>", "value"=>"<string>"}, {"key"=>"<string>", "name"=>"<string>", "value"=>"<string>"}], "dept"=>"<string>", "first_name"=>"<string>", "group_id"=>"<string>", "host_key"=>"<string>", "job_title"=>"<string>", "language"=>"<string>", "last_name"=>"<string>", "location"=>"<string>", "manager"=>"<email>", "phone_country"=>"<string>", "phone_number"=>"<string>", "phone_numbers"=>[{"code"=>"<string>", "country"=>"<string>", "label"=>"Office", "number"=>"<string>"}, {"code"=>"<string>", "country"=>"<string>", "label"=>"Mobile", "number"=>"<string>"}], "pmi"=>"<integer>", "pronouns"=>"<string>", "pronouns_option"=>3, "timezone"=>"<string>", "type"=>99, "use_pmi"=>false, "vanity_name"=>"<string>", "display_name"=>"<string>", "zoom_one_type"=>128, "plan_united_type"=>"8192", "feature"=>{"zoom_phone"=>"<boolean>"}, "about_me"=>"<string>", "linkedin_url"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring