WarmupBulk warmup operations

Bulk warmup operations

Runs a warmup lifecycle operation across many mailboxes in one call. Each item may carry its own config (start only); an item without one falls back to the top-level config, then to that mailbox's provider default. Each mailbox is processed independently — a failure (bad DNS, wrong state, inactive) is reported per-mailbox and does not fail the request. For start, each mailbox is DNS-gated exactly like the single-mailbox endpoint. Repeated mailboxIds are de-duplicated. Maximum 100 mailboxes per request.

curl -X POST "https://api.sendkit.ai/v1/warmup/bulk" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "operation": "start",
  "mailboxes": [
    {
      "mailboxId": "664a1b2c3d4e5f6a7b8c9d03"
    },
    {
      "mailboxId": "664a1b2c3d4e5f6a7b8c9d04"
    }
  ]
}'
{
  "success": true,
  "data": {
    "operation": "start",
    "total": 2,
    "succeeded": 1,
    "failed": 1,
    "results": [
      {
        "mailboxId": "664a1b2c3d4e5f6a7b8c9d03",
        "success": true,
        "status": "in_progress",
        "healthScore": 100,
        "config": {
          "startingVolume": 10,
          "dailyIncrease": 1,
          "targetVolume": 25
        }
      },
      {
        "mailboxId": "664a1b2c3d4e5f6a7b8c9d04",
        "success": false,
        "error": "DNS records incomplete",
        "healthScore": 60,
        "issues": [
          "DMARC record not configured"
        ]
      }
    ]
  }
}
POST
/v1/warmup/bulk
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Content-Typestring
Required

The media type of the request body

Options: application/json
operationstring
Required
Options: start, pause, resume, stop
configstring

Global fallback config applied to start items without their own config

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Body

application/json
operationstring
Required
Allowed values:startpauseresumestop
configstring

Global fallback config applied to start items without their own config

Responses

successboolean
dataobject