MailPilot API

Update warmup settings

Set `status: "RUNNING"` to start or resume warmup - this verifies the mailbox's connection first and fails with 422 if it can't authenticate. A mailbox suspended for high bounce rate cannot be restarted via this endpoint (403). Any other provided fields (strategy, limits, schedule, `useOwnTemplates`, `hiddenWarmup`, alerting) are merged into the existing settings - omitted fields are left unchanged.

PATCH
/api/email-accounts/{id}/warmup

Set status: "RUNNING" to start or resume warmup - this verifies the mailbox's connection first and fails with 422 if it can't authenticate. A mailbox suspended for high bounce rate cannot be restarted via this endpoint (403). Any other provided fields (strategy, limits, schedule, useOwnTemplates, hiddenWarmup, alerting) are merged into the existing settings - omitted fields are left unchanged.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

An API key generated from Settings → API Keys in the MailPilot dashboard, sent as Authorization Bearer <key>.

In: header

Path Parameters

id*integer

Mailbox ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/email-accounts/0/warmup" \  -H "Content-Type: application/json" \  -d '{    "status": "RUNNING",    "strategy": "PROGRESSIVE",    "dailySendingLimit": 40,    "replyRate": 30  }'
{  "data": {    "warmupStatus": "IDLE",    "currentDay": 0,    "strategy": "PROGRESSIVE",    "dailySendingLimit": 0,    "initialSendingLimit": 0,    "increaseByNumber": 0,    "maxSendingLimit": 0,    "replyRate": 0,    "sendDays": "string",    "sendWindowStart": 0,    "sendWindowEnd": 0,    "pauseOnBounces": true,    "bounceThreshold": 0,    "sendSchedule": "string",    "sendingMode": "string",    "randomMinVolume": 0,    "randomMaxVolume": 0,    "useOwnTemplates": true,    "hiddenWarmup": true,    "alertEmail": "string",    "alertThreshold": 0,    "alertSlackWebhook": "string",    "espGoogleWeight": 0,    "espMicrosoftWeight": 0,    "espOtherWeight": 0,    "hasCustomSettings": true  }}