Update Mailbox Details
PATCH
/mailboxes/update-mailbox-details
mailboxData accepts either a single object (backward compatible) or an array of objects for bulk updates — each with its own mailboxId and independent fields.Single mailbox update
{
"mailboxData": {
"mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
"userName": "alice.doe",
"firstName": "Alice",
"lastName": "Doe"
}
}Bulk update (array)
{
"mailboxData": [
{ "mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR", "firstName": "Alice", "lastName": "Doe" },
{ "mailboxId": "ANOTHER_ID", "userName": "bob.smith", "firstName": "Bob" }
]
}Remove profile picture
removeProfilePicture: true to clear the current profile picture.{
"mailboxData": {
"mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR",
"removeProfilePicture": true
}
}Response
mailboxData is an object, data is a single result object.When
mailboxData is an array, data is an array with a per-mailbox result:{
"message": "Mailbox details will update shortly",
"data": [
{ "mailboxId": "GP6M2J2DHXM3F2J40S8AP316R2QR", "success": true, "message": "Mailbox details will update shortly" },
{ "mailboxId": "ANOTHER_ID", "success": false, "message": "Rate limit exceeded" }
]
}Request
Query Params
Body Params application/jsonRequired
Responses
Request 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 Response Example
200 - Example 1
{
"status": 200,
"message": "Mailbox details will update shortly",
"actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}Modified at 2026-08-18 07:46:44