Update user

PUT

/domains/{domain}/users/{user}

Last modified:2026-10-08 23:06:15

OperationId:UpdateUser

Changes a user. Send only the fields to change. A field you leave out keeps its value. Send an empty site, department, or email to clear it.

A Basic User token changes only its own user. Site Manager, Office Manager, Reseller, and Super User tokens change the users in their domains.

Some changes have conditions:

Your own password or email. Send current_password with your current password. Without it, when a password is already set, password-hash and email are not changed. A wrong current_password is a 403.

Scope. You can give a user your own scope or a lower one. A higher scope is a 403.

Email for scopes below Reseller. When the domain does not allow users to edit their primary email, changing email from a scope below Reseller is a 403.

A new password signs the user out everywhere and sends the user a security notification. An empty password-hash resets the account: it removes the user's single sign-on links and signs the user out.

The masked PIN. Sending back the masked voicemail-login-pin from a read leaves the PIN unchanged.

The response is 202: the change is accepted and applied shortly after.

The named examples change a name and caller ID, move a user to another site, change your own password, and clear a department.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

The change is accepted and applied shortly after this response.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

Change name and caller IDMove to another siteChange your own passwordClear the department

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name-first-name": "Main",
    "name-last-name": "Reception",
    "caller-id-number": "15555550102",
    "caller-id-name": "Example Reception"
}'

Response Example

202 - Change name and caller ID

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-08 23:06:15

Delete user

Read user