Use this endpoint to update the details of an existing user. This endpoint requires 2FA.
Permissions required:
edit-other-user-password: Permission to modify other user's passwordsedit-other-user-info_description: Permission to change other user's name, username or email addressedit-other-user-active-status: Permission to enable or disable other accounts
Changelog
| Version | Description |
|---|---|
| 7.0.0 | Removed upsert behaviour and stopped allowing joinDefaultChannels param |
| 0.48.0 | Renamed to users.update |
| 0.35.0 | Added |
The authenticated user ID.
The authenticated user token.
Enter the 2FA code. This parameter is required if 2FA is enabled in your workspace. See the Introduction to Two-Factor Authentication document for details.
Enter the method with which you get the 2FA code. It can be email, totp, or password. This parameter is required if 2FA is enabled in your workspace.
The user ID to update. This value must not be empty.
The object that includes the user information to update with the following parameters. Note: If you provide an empty object, the user details are returned.
The name of the user.
The email ID of the user.
The password for the user.
The username for the user.
Whether the user is active, which determines if they can log in. Setting this to false deactivates the user. If the user is the last owner of any room, or the only member of a private room, the request fails with user-last-owner unless confirmRelinquish is also true. See confirmRelinquish.
The roles the user has been assigned.
Whether the user should be required to change their password when they login.
Whether the user should get a welcome email.
The voice call extension.
Whether the user's email address should be verified.
Any custom fields the user should have on their account. To save custom fields, you must first define the custom fields in the admin panel (Manage > Workspace > Settings > Accounts > Registration > Custom Fields). For details on how to configure this field, see Custom Fields. For information on how to view the custom fields, see the Get Users List endpoint.
Top-level body parameter (not inside data). Only used when data.active is false. Set to true to deactivate the user even if they are the last owner of a room, or the only member of a private room.
If the room has other active members, the member who joined earliest becomes the new owner. If the user is the only member of a private room, or no other active member can take ownership, that room is deleted, together with every discussion that belongs to it. Public channels are not deleted.
If omitted or false and the user is the last owner of any room, the request fails with user-last-owner and the user's active status is not changed.
OK
{
"user": {
"_id": "PMGoujw82oETsaw9828rQh2oXM",
"createdAt": "2026-02-24T23:22:54.986Z",
"username": "agent2",
"emails": [
{
"address": "agent2@agent.com",
"verified": false
}
],
"type": "user",
"roles": [
"user",
"livechat-agent"
],
"status": "offline",
"active": true,
"inactiveReason": null,
"name": "Agent 2 Updated",
"_updatedAt": "2026-02-25T14:25:59.157Z",
"__rooms": [
"GENERAL"
],
"requirePasswordChange": false,
"settings": {},
"statusText": "",
"livechatStatusSystemModified": false,
"statusLivechat": "not-available"
},
"success": true
}Bad Request
{
"success": false,
"error": "Editing user is not allowed [error-action-not-allowed]",
"errorType": "error-action-not-allowed",
"details": {
"method": "insertOrUpdateUser",
"action": "Editing_user"
}
}{
"success": false,
"error": "[user-last-owner]",
"errorType": "user-last-owner",
"details": {
"shouldBeRemoved": [
"cascade-test-group"
],
"shouldChangeOwner": []
}
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}