Developers
Open Swarmhit
Smart APIRaw API
API referenceWarmup
GET
/email-accounts/{id}/warmup

JavaScript SDK: swarmhit.emailAccounts.warmup.get(emailAccountId)

Warmup of a mailbox bought through Swarmhit: status, strategy, warmup day, current and target daily volume, health, inbox rate, and the campaign hold (holdUntil, holdReason). limits.maxTarget is the highest target volume this mailbox may warm to (the email tier's ceiling minus its campaign cap). 409 with code: not-managed for a mailbox the workspace connected itself: warmup is available for mailboxes bought through Swarmhit.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/email-accounts/string/warmup"
{  "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    }  }}

Update a sender PATCH

**JavaScript SDK:** [`swarmhit.senders.update(senderId, params)`](/smart-api/sdk/methods#senders) Only the fields given are written (at least one). A list replaces the sender's accounts of that kind (`[]` unlinks them all), and `linkedinAccountId` replaces its LinkedIn account (`null` unlinks it). An account linked here leaves the sender it had.

Warmup daily series GET

**JavaScript SDK:** [`swarmhit.emailAccounts.warmup.getStats(emailAccountId, params?)`](/smart-api/sdk/methods#emailAccounts.warmup) 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.