Toggle Warmup

POST

/mailboxes/warmup/toggle

Toggles warmup between ACTIVE and PAUSED.

data.status in the response reflects the new state after toggling.

{ "data": { "status": "PAUSED" } }

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Query Params

Responses

🟢200Success

application/json

Warmup paused

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

🟠422Unprocessable Entity

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://customers.coldmailreseller.com/api/v1/integration/mailboxes/warmup/toggle?mailboxId=GP6M2J2DHXM3F2J40S8AP316R2QR' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Warmup paused",
    "data": {
        "status": "PAUSED"
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

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

Add Warmup to Mailbox

Update Warmup Settings