Update a User

Updates a user and returns the updated user.

Request URL

PUT {base_url}/uc-cconfig/api/v1/users/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the user to update. You can obtain the ID using the Search Users interface.
Body parameters
Parameter Required Type Description
firstName No String The first name of the user. The value ranges from 1 to 63 characters.
lastName No String The last name of the user. The maximum length is 63 characters.
email No String The email address of the user. The maximum length is 127 characters.
mobile No String The mobile number of the user in E.164 format.
userRole No String

The role of the user.

Valid value:

  • ROLE_USER: A normal user.
  • ROLE_ADMIN: An administrator.
jobTitle No String The job title of the user. The maximum length is 127 characters.
registerInfo No Object<Register_Info_Input> The registration information of the user.
userPassword No String The user password, in plaintext or RSA-JWE ciphertext.
Register_Info_Input
Parameter Required Type Description
callerId No String The caller ID of the user.
registrationPassword No String The plaintext or RSA-JWE ciphertext registration password.
registrationName No String The registration name. If omitted, it is generated by the system.
ipPhoneConcurrent No Integer The maximum concurrent calls for IP phones, ranging from 0 to 10.
mobileConcurrent No Integer The maximum concurrent calls for mobile clients, ranging from 0 to 10.
desktopConcurrent No Integer The maximum concurrent calls for desktop clients, ranging from 0 to 10.
webConcurrent No Integer The maximum concurrent calls for web clients, ranging from 0 to 10.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<User_Brief> The updated user.
User_Brief
Parameter Type Description
id String The ID of the user.
extension String The extension number of the user.
firstName String The first name of the user.
lastName String The last name of the user.
email String The email address of the user.
mobile String The mobile number of the user.
userRole String

The role of the user:

  • ROLE_USER
  • ROLE_ADMIN
currentPresence String

The current presence status of the user:

  • AVAILABLE
  • AWAY
  • DND
  • LUNCH
  • BUSINESS_TRIP
  • OFF_WORK
createdAt String The time when the user was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the user was last updated, in Unix timestamp format (milliseconds).
avatarUrl String The avatar URL of the user.