Set the strategy: a preset name, or custom values. Only the values that changed are sent to the warmup network. Starting volume only applies to warmup day 1 and is refused afterwards (409, code: starting-volume-locked). Before warmup has started the strategy is stored and applied as soon as it does. An invalid strategy is 400 with code: invalid-strategy and details.errors listing each field.
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 PATCH "https://example.com/email-accounts/string/warmup" \ -H "Content-Type: application/json" \ -d '{ "strategy": "conservative" }'{ "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 } }}Stop warmup POST
Stop the mailbox's warmup for good (cancelled at the warmup network). Start it again with POST /email-accounts/{id}/warmup/start.
Create a webhook endpoint POST
Registers an endpoint that receives the subscribed events. The response includes a `secret` — store it to verify delivery signatures.