Update My Profile

Overview

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.

When to use this endpoint?

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.

Editable Fields

Field	Type	Required	Description
name	string	Optional	New display name. At least one of name or profileImage must be present.
profileImage	string \| null	Optional	Avatar image URL. Send `null` to clear if supported by your client.
metadata	object	Optional	Arbitrary key-value map for preferences and app-specific data.

Single-Field Updates

Examples for updating one concern at a time:

Name only

json

1{2  "name": "New Name"3}

Profile image only

json

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

Metadata (with a name or image also required by validation)

json

1{2  "metadata": {3    "theme": "dark"4  }5}

PATCH{baseUrl}/api/{apiVersion}/user/profile/me

Authentication: Required (Bearer token)
Tenant-scoped: Yes (tenant DB - requires x-client-id)

Request Headers

Header	Value	Description
Authorization	Bearer <access_token>	Chat user Access Token (Bearer) for the signed-in messaging participant.
is-tenant	true	Targets the tenant DB ("true", needs x-client-id).
x-client-id	{{clientId}}	Tenant (client) id. Required when is-tenant=true.
Content-Type	application/json	JSON request body.

Request Payload

Combined example updating name, avatar, and metadata:

json

1{2  "name": "New Name",3  "profileImage": "https://example.com/profile-image.png",4  "metadata": {5    "theme": "dark"6  }7}

Success Response (HTTP 200 OK)

On success, the API returns the updated profile summary.

json

1{2  "success": true,3  "message": "Profile updated successfully",4  "data": {5    "_id": "6a58...90d",6    "name": "New Name",7    "email": "will.smith@example.com",8    "role": "user",9    "profileImage": "https://example.com/profile-image.png"10  },11  "error": null12}

Common Errors

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

HTTP 400 Bad Request - Nothing to update

json

1{2  "success": false,3  "message": "Provide at least one of: name, profileImage",4  "data": null,5  "error": null6}

HTTP 401 Unauthorized - No token

json

1{2  "success": false,3  "message": "No token, authorization denied",4  "data": null,5  "error": "Unauthorized"6}

Code	Reason
400 Bad Request	Provide at least one of `name` or `profileImage`.
401 Unauthorized	Access Token is missing, invalid, or expired.
500 Internal Server Error	An unexpected error occurred while updating the profile.

Best Practices

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.

Chat profile updated

Update the chat header and sidebar from the response, or call Get My Profile again if your client prefers a separate reload.

Overview

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

When to use this endpoint?

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.

Field

Type

Required

Description

name

string

Optional

New display name. At least one of name or profileImage must be present.

profileImage

string | null

Optional

Avatar image URL. Send null to clear if supported by your client.

metadata

object

Optional

Arbitrary key-value map for preferences and app-specific data.

Request Headers

Header	Value	Description
Authorization	Bearer <access_token>	Chat user Access Token (Bearer) for the signed-in messaging participant.
is-tenant	true	Targets the tenant DB ("true", needs x-client-id).
x-client-id	{{clientId}}	Tenant (client) id. Required when is-tenant=true.
Content-Type	application/json	JSON request body.

Success Response (HTTP 200 OK)

On success, the API returns the updated profile summary.

json

1{2  "success": true,3  "message": "Profile updated successfully",4  "data": {5    "_id": "6a58...90d",6    "name": "New Name",7    "email": "will.smith@example.com",8    "role": "user",9    "profileImage": "https://example.com/profile-image.png"10  },11  "error": null12}

Common Errors

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

HTTP 400 Bad Request - Nothing to update

json

1{2  "success": false,3  "message": "Provide at least one of: name, profileImage",4  "data": null,5  "error": null6}

HTTP 401 Unauthorized - No token

json

1{2  "success": false,3  "message": "No token, authorization denied",4  "data": null,5  "error": "Unauthorized"6}

Code	Reason
400 Bad Request	Provide at least one of `name` or `profileImage`.
401 Unauthorized	Access Token is missing, invalid, or expired.
500 Internal Server Error	An unexpected error occurred while updating the profile.