WarmupUpdate warmup settings

Update warmup settings

Partially updates the mailbox's warmup config. Only the fields supplied are changed; omitted fields are left as-is. replyRates is shallow-merged, so supplying only spam preserves the existing inbox/promotions rates. targetVolume is capped at 50, and the effective startingVolume may not exceed the effective targetVolume. This does not re-run the DNS check.

curl -X PATCH "https://api.sendkit.ai/v1/warmup/config/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "targetVolume": 40
}'
{
  "success": true,
  "data": {
    "mailboxId": "664a1b2c3d4e5f6a7b8c9d03",
    "updated": {
      "warmup.config.targetVolume": 40
    }
  }
}
PATCH
/v1/warmup/config/{mailboxId}
PATCH
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
startingVolumeinteger

Day-1 daily send volume

Min: 1 • Max: 50
dailyIncreaseinteger

Volume added each day

Min: 1 • Max: 50
targetVolumeinteger

Daily volume ceiling (hard-capped at 50)

Min: 1 • Max: 50
replyRatesobject

Reply-rate targets as percentages (0–100).

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_...)

Path Parameters

Body

application/json
startingVolumeinteger

Day-1 daily send volume

dailyIncreaseinteger

Volume added each day

targetVolumeinteger

Daily volume ceiling (hard-capped at 50)

replyRatesobject

Reply-rate targets as percentages (0–100).

Responses

successboolean
dataobject