Update mailbox details

PATCH

/mailboxes/update-mailbox-details

Updates the first name, last name, email username, and profile picture for an active mailbox.

Rate limit:

Maximum 2 updates per mailbox per day.

Update behavior:

Only the fields explicitly provided in the request will be updated.

Fields not passed in the request will remain unchanged.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Body Params application/json

Example

{
    "mailboxData": {
        "mailboxId": "HKSWJDKSDKSDKSDOSDISDS",
    "firstName" : "John",
    "lastName": "Doe",
    "userName": "john",
    "profilePicture": "https://images.unsplash.com/photo-1742147550712-9c25dc0832aa?w=500&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxmZWF0dXJlZC1waG90b3MtZmVlZHw1fHx8ZW58MHx8fHx8"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/update-mailbox-details?userId' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mailboxData": {
        "mailboxId": "HKSWJDKSDKSDKSDOSDISDS",
    "firstName" : "John",
    "lastName": "Doe",
    "userName": "john",
    "profilePicture": "https://images.unsplash.com/photo-1742147550712-9c25dc0832aa?w=500&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxmZWF0dXJlZC1waG90b3MtZmVlZHw1fHx8ZW58MHx8fHx8"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Mailbox details will update shortly",
    "data": null
}

🟠400Mailbox Update In Progress

🟠400Mailbox not found

Modified at 2025-12-16 18:16:51

Get Mailbox Admin Details

Remove mailbox