Update Mailbox Details

PATCH

/mailboxes/update-mailbox-details

Updates the display name, username, or profile picture for a mailbox.

Changes are applied asynchronously on the workspace provider.

Update name and username

{
  "mailboxData": {
    "mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
    "userName": "alice.doe",
    "firstName": "Alice",
    "lastName": "Doe"
  }
}

Remove profile picture

Set removeProfilePicture: true to clear the current profile picture.

{
  "mailboxData": {
    "mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
    "removeProfilePicture": true
  }
}

Note: Profile data update is blocked if another update is already in progress for the same mailbox.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Mailbox details will update shortly

Bodyapplication/json

🟠401Unauthorized

🟠422Unprocessable Entity

🟠400Bad Request

🟠404Not Found

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/update-mailbox-details?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "mailboxData": {
        "mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
        "userName": "alice.doe",
        "firstName": "Alice",
        "lastName": "Doe",
        "profilePicture": "https://cdn.example.com/avatar.jpg",
        "removeProfilePicture": false
    }
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Mailbox details will update shortly",
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Get Admin Mailbox Details

Delete Mailbox

Update Mailbox Details

Update name and username#

Remove profile picture#

Request

Responses

Update name and username

Remove profile picture