WarmupGet warmup config

Get warmup config

Returns the mailbox's current warmup config and state, plus the provider defaults.

curl -X GET "https://api.sendkit.ai/v1/warmup/config/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "mailboxId": "664a1b2c3d4e5f6a7b8c9d03",
    "provider": "gmail",
    "enabled": true,
    "status": "in_progress",
    "currentDay": 3,
    "currentVolume": 12,
    "config": {
      "startingVolume": 10,
      "dailyIncrease": 1,
      "targetVolume": 25,
      "replyRates": {
        "inbox": {
          "min": 30,
          "max": 45
        },
        "promotions": {
          "min": 15,
          "max": 25
        },
        "spam": 100
      }
    },
    "defaults": {
      "startingVolume": 10,
      "dailyIncrease": 1,
      "targetVolume": 25,
      "replyRates": {
        "inbox": {
          "min": 30,
          "max": 45
        },
        "promotions": {
          "min": 15,
          "max": 25
        },
        "spam": 100
      }
    }
  }
}
GET
/v1/warmup/config/{mailboxId}
GET
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_...)
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

Responses

successboolean
dataobject