Update User

Partially update a chat user by id from the messaging app (email, role, or metadata). You can change a single field or several fields in one request.

Only these request payload fields are updated through this endpoint:

• email
• role
• metadata

On success, the API returns the updated user so your chat UI can refresh without an extra fetch. For the signed-in participant's own display name or avatar, use Update My Profile. For Platform panel user management, use Platform → Users → Update.

Use Update User when:

• A chat flow needs to correct a participant's email (email only).
• You assign or change a chat-side role slug (role only).
• Chat metadata (locale, team labels) must be added or updated (metadata only).
• You want to apply several of the fields above in one call from the chat client.

Part of the Chat User APIs. Send only the fields you want to change. Prefer Update My Profile for self name / avatar edits.

The table below lists every field this endpoint accepts. Each field can be updated on its own or combined with others.

You do not need to resend the full user. Examples for one field at a time:

{
  "email": "usertest@gmail.com"
}

{
  "role": "sales-manager"
}

{
  "metadata": {
    "employeeId": "E-204"
  }
}

Combined update example changing email, role, and metadata together:

{
  "email": "usertest@gmail.com",
  "role": "sales-manager",
  "metadata": {
    "employeeId": "E-204"
  }
}

On success, the API returns the updated user document.

{
  "success": true,
  "message": "User updated successfully",
  "data": {
    "_id": "694b76ab3d833c4b8a3f57d8",
    "name": "project user",
    "email": "usertest@gmail.com",
    "isActive": true,
    "role": "user",
    "createdAt": "2025-12-24T05:14:19.695Z",
    "updatedAt": "2025-12-24T06:29:09.840Z",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2OTRiNzZhYjNkODMzYzRiOGEzZjU3ZDgiLCJlbWFpbCI6InVzZXJwM0BoZ21haWwuY29tIiwiaWF0IjoxNzY2NTU3MzE4LCJleHAiOjE3NjcxNjIxMTh9.QXEY2iGPCEzLYJ5i_GqUZOQt06gihz83pveo_MjCj-o"
  },
  "error": null
}

Update fails when the token is missing, the user does not exist, or the payload is invalid.

{
  "success": false,
  "message": "No token, authorization denied",
  "data": null,
  "error": "Unauthorized"
}

{
  "success": false,
  "message": "User not found",
  "data": null,
  "error": "User not found"
}

• Prefer single-field updates from chat settings — smaller payloads and clearer UX.
• Use Update My Profilefor the signed-in user's name and avatar; reserve this endpoint for email / role / metadata.
• Keep metadata keys stable so people-picker filters remain correct.
• Always send tenant headers with the chat user Bearer token over HTTPS.