Delete a User

Deletes a user. The user is logically deleted.

Request URL

DELETE {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 delete. You can obtain the ID using the Search Users interface.

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 deleted 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.