Update My Profile

Partially update the signed-in chat participant's own profile. Identity comes from the Bearer token — no path id is required.

Editable fields:

• name
• profileImage
• metadata

Provide at least one of name or profileImage. Use this from chat settings for display name and avatar. For another user's email or role, use Update User. For Platform client branding, use Platform → Update Profile.

Use Update My Profile when:

• The chat participant renames themselves in settings (name only).
• They change their chat avatar URL (profileImage only).
• They store chat preferences in metadata (theme, locale, and so on).
• Chat settings saves several of the fields above in one request.

Part of the Chat User APIs. An empty body or a body without name / profileImage returns 400.

Examples for updating one concern at a time:

{
  "name": "New Name"
}

{
  "profileImage": "https://example.com/profile-image.png"
}

{
  "metadata": {
    "theme": "dark"
  }
}

Combined example updating name, avatar, and metadata:

{
  "name": "New Name",
  "profileImage": "https://example.com/profile-image.png",
  "metadata": {
    "theme": "dark"
  }
}

On success, the API returns the updated profile summary.

{
  "success": true,
  "message": "Profile updated successfully",
  "data": {
    "_id": "6a58...90d",
    "name": "New Name",
    "email": "will.smith@example.com",
    "role": "user",
    "profileImage": "https://example.com/profile-image.png"
  },
  "error": null
}

Profile update fails when nothing is provided to update or the token is missing.

{
  "success": false,
  "message": "Provide at least one of: name, profileImage",
  "data": null,
  "error": null
}

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

• Upload the avatar to storage first, then send the public URL as profileImage.
• Prefer single-field saves from chat settings for clearer UX.
• Refresh the chat shell avatar and name from the success response.
• Always send tenant headers with the chat user Bearer token over HTTPS.