A warming mailbox is held out of campaigns until its hold ends (14 days and good health by default). on: true lets campaigns use it now, at a deliverability risk; on: false holds it again.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
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
curl -X POST "https://example.com/email-accounts/string/warmup/hold-override" \ -H "Content-Type: application/json" \ -d '{ "on": true }'{ "data": { "warmup": { "provider": "string", "status": "pending", "statusLabel": "string", "strategy": { "preset": "conservative", "startingVolume": 1, "dailyIncrease": 1, "targetVolume": 1, "replyInbox": [ 0, 0 ], "replyPromotions": [ 0, 0 ], "replySpam": 0 }, "strategyApplied": true, "day": 0, "currentVolume": 0, "targetVolume": 0, "health": "excellent", "healthLabel": "string", "healthScore": 0, "inboxRate": 0, "startedAt": "2019-08-24T14:15:22Z", "holdUntil": "2019-08-24T14:15:22Z", "holdReason": "warming", "holdOverride": true, "syncedAt": "2019-08-24T14:15:22Z", "error": "string" }, "available": true, "limits": { "maxTarget": 0, "tierMax": 0, "campaignCap": 0 } }}Warmup daily series GET
One row per UTC day, oldest first: warmup emails sent and received, campaign sends, replies, bounces, inbox rate and health. Recorded once a day, so today is not in it yet.
Pause warmup POST
Pause the mailbox's warmup. Campaigns are not affected by a warmup pause. `409` with `code: warmup-not-running` when warmup has not started.