Update Profile

Overview

Update the authenticated client's profile fields such as name, email, slug, active status, profile image, cover gradient, and metadata in the tenant database.

Send only the fields you want to change. profileImage and coverGradient are optional and may be set to null to clear them. On success, the API returns the updated profile record so you can refresh your UI immediately.

When to use this endpoint?

Use Update Profile when:

The client edits their display name, email, slug, or active status.
You need to set, replace, or clear the profile image (profileImage can be a URL or null).
You need to set, replace, or clear the cover gradient (coverGradient can be a gradient key or null).
An account settings form needs to persist profile changes or custom metadata.
You want to update profile details without changing the password (use Change Password for that).

PATCH{baseUrl}/api/{apiVersion}/client/profile

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

Request Headers

Header	Value	Description
Authorization	Bearer <access_token>	The Access Token for the authenticated client session.
Content-Type	application/json	Specifies the content type of the request body.
is-tenant	true	Targets the tenant DB ("true", needs x-client-id) or the root DB ("false", e.g. client register/create).
x-client-id	{{clientId}}	Tenant (client) id. Required when is-tenant=true. Uses the {{clientId}} variable.

Request Payload

All fields below are optional for a partial update. Include only the properties you want to change. To clear the profile image or cover gradient, send null.

json

1{2  "name": "Acme Inc",3  "coverGradient": "brand-blue" 4  "email": "clientpro1@yopmail.com",5  "isActive": true,6  "profileImage": "https://example.com/profile.jpg",7  "slug": "client-pro-1",8  "metadata": {9    "industry": "fintech"10  }11}

Field	Type	Required	Description
name	string	Optional	Display name for the client workspace.
email	string	Optional	Email address for the client. Must be unique across clients.
slug	string	Optional	URL-friendly identifier. Use lowercase letters, numbers, and hyphens only.
isActive	boolean	Optional	Whether the client account is active.
profileImage	string \| null	Optional	Public URL of the profile image. Send `null` to remove the current image.
coverGradient	string \| null	Optional	Cover gradient key (for example `brand-blue`). Send `null` to clear the cover gradient.
metadata	object	Optional	Custom key/value data stored with the client profile.

Success Response (HTTP 200 OK)

When the update succeeds, the API returns the updated client profile.

json

1{2  "success": true,3  "message": "Profile updated successfully",4  "data": {5    "_id": "699fe1377846dcfb775c645c",6    "name": "Acme Inc",7    "email": "clientpro1@yopmail.com",8    "slug": "client-pro-1",9    "isActive": true,10    "profileImage": "https://example.com/profile.jpg",11    "coverGradient": "brand-blue",12    "slug": "client-pro-1",13    "metadata": {14      "industry": "fintech"15    },16    "createdAt": "2026-02-26T05:59:19.339Z",17    "updatedAt": "2026-02-26T05:59:20.031Z"18  },19  "error": null20}

Error Responses

HTTP 409 Conflict - Error - Email taken (409)

json

1{2  "success": false,3  "message": "A client with this email already exists",4  "data": null,5  "error": "A client with this email already exists"6}

Status Codes

Code	Meaning
200	Success
409	Error - Email taken (409)

Common Errors

Profile updates fail when authentication is invalid or the new email conflicts with an existing client.

Code	Meaning	Reason
400 Bad Request	Invalid or missing fields	The request body contains invalid data.
401 Unauthorized	Unauthorized	Access Token is missing, invalid, or expired.
409 Conflict	Email taken	A client with this email already exists.
500 Internal Server Error	Unexpected error	An unexpected error occurred while updating the profile.

You’re ready to continue

After a successful update, refresh your UI with the returned profile or call Client → Get Profile to confirm the latest values.

Best Practices

Send only the fields that changed - this endpoint supports partial updates.
To clear profileImage or coverGradient, send null instead of an empty string.
Validate email format and slug pattern on the client before submitting to avoid unnecessary 400 responses.
Handle 409 Conflict clearly in the UI when the email is already taken.
Always include Content-Type: application/json with the request body.
After updating, refresh local profile state from the success response or a follow-up Get Profile call.

Update Profile

Overview

Update the authenticated client's profile fields such as name, email, slug, active status, profile image, cover gradient, and metadata in the tenant database.

When to use this endpoint?

Use Update Profile when:

The client edits their display name, email, slug, or active status.
You need to set, replace, or clear the profile image (profileImage can be a URL or null).
You need to set, replace, or clear the cover gradient (coverGradient can be a gradient key or null).
An account settings form needs to persist profile changes or custom metadata.
You want to update profile details without changing the password (use Change Password for that).

PATCH{baseUrl}/api/{apiVersion}/client/profile

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

Request Headers

Header	Value	Description
Authorization	Bearer <access_token>	The Access Token for the authenticated client session.
Content-Type	application/json	Specifies the content type of the request body.
is-tenant	true	Targets the tenant DB ("true", needs x-client-id) or the root DB ("false", e.g. client register/create).
x-client-id	{{clientId}}	Tenant (client) id. Required when is-tenant=true. Uses the {{clientId}} variable.

Request Payload

All fields below are optional for a partial update. Include only the properties you want to change. To clear the profile image or cover gradient, send null.

json

1{2  "name": "Acme Inc",3  "coverGradient": "brand-blue" 4  "email": "clientpro1@yopmail.com",5  "isActive": true,6  "profileImage": "https://example.com/profile.jpg",7  "slug": "client-pro-1",8  "metadata": {9    "industry": "fintech"10  }11}

Field	Type	Required	Description
name	string	Optional	Display name for the client workspace.
email	string	Optional	Email address for the client. Must be unique across clients.
slug	string	Optional	URL-friendly identifier. Use lowercase letters, numbers, and hyphens only.
isActive	boolean	Optional	Whether the client account is active.
profileImage	string \| null	Optional	Public URL of the profile image. Send `null` to remove the current image.
coverGradient	string \| null	Optional	Cover gradient key (for example `brand-blue`). Send `null` to clear the cover gradient.
metadata	object	Optional	Custom key/value data stored with the client profile.

Success Response (HTTP 200 OK)

When the update succeeds, the API returns the updated client profile.

json

1{2  "success": true,3  "message": "Profile updated successfully",4  "data": {5    "_id": "699fe1377846dcfb775c645c",6    "name": "Acme Inc",7    "email": "clientpro1@yopmail.com",8    "slug": "client-pro-1",9    "isActive": true,10    "profileImage": "https://example.com/profile.jpg",11    "coverGradient": "brand-blue",12    "slug": "client-pro-1",13    "metadata": {14      "industry": "fintech"15    },16    "createdAt": "2026-02-26T05:59:19.339Z",17    "updatedAt": "2026-02-26T05:59:20.031Z"18  },19  "error": null20}

Error Responses

HTTP 409 Conflict - Error - Email taken (409)

json

1{2  "success": false,3  "message": "A client with this email already exists",4  "data": null,5  "error": "A client with this email already exists"6}

Status Codes

Code	Meaning
200	Success
409	Error - Email taken (409)

Common Errors

Profile updates fail when authentication is invalid or the new email conflicts with an existing client.

Code	Meaning	Reason
400 Bad Request	Invalid or missing fields	The request body contains invalid data.
401 Unauthorized	Unauthorized	Access Token is missing, invalid, or expired.
409 Conflict	Email taken	A client with this email already exists.
500 Internal Server Error	Unexpected error	An unexpected error occurred while updating the profile.

You’re ready to continue

After a successful update, refresh your UI with the returned profile or call Client → Get Profile to confirm the latest values.

Best Practices

Send only the fields that changed - this endpoint supports partial updates.
To clear profileImage or coverGradient, send null instead of an empty string.
Validate email format and slug pattern on the client before submitting to avoid unnecessary 400 responses.
Handle 409 Conflict clearly in the UI when the email is already taken.
Always include Content-Type: application/json with the request body.
After updating, refresh local profile state from the success response or a follow-up Get Profile call.