logo
MailboxesBulk mailbox operations
Mailboxes

Bulk mailbox operations

Perform bulk operations on multiple mailboxes. Two selection modes:

  • Explicit IDs: { "mailboxIds": ["id1", "id2"] }
  • Filter-based: { "selectAll": true, "filters": { ... }, "excludeIds": ["id3"] }

Available operations:

OperationExtra FieldsDescription
enableSendingEnable sending on selected mailboxes
disableSendingDisable sending
updateDailyLimitdailySendLimit (1-50)Set daily send limit
updateSignaturesignatureTemplateSet signature with \{\{firstName\}\}, \{\{lastName\}\}, \{\{email\}\} auto-personalized per mailbox
addTagstags[]Add tags (no duplicates)
removeTagstags[]Remove specific tags
replaceTagstags[]Replace all tags
checkDNSCheck MX, SPF, DKIM, DMARC records (grouped by domain)
startWarmupwarmupConfig?Start warmup (default: 10 emails/day, +1/day, target 25, max 50)
pauseWarmupPause active warmup
resumeWarmupResume paused/stopped warmup
stopWarmupStop warmup completely
updateWarmupSettingswarmupConfigUpdate warmup config (startingVolume, dailyIncrease, targetVolume)
reactivateReactivate errored/suspended mailboxes
deleteDelete mailboxes (fails if used in active campaigns)
curl -X POST "https://api.sendkit.ai/v1/mailboxes/bulk" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "operation": "enableSending",
  "mailboxIds": [
    "665b1c2d3e4f5a6b7c8d9e0f",
    "665b1c2d3e4f5a6b7c8d9e10"
  ]
}'
{
  "success": true,
  "data": {
    "operation": "enableSending",
    "modifiedCount": 5
  }
}
POST
/v1/mailboxes/bulk
POST
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_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Content-Typestring
Required

The media type of the request body

Options: application/json
operationstring
Required

The bulk operation to perform

Options: enableSending, disableSending, updateDailyLimit, updateSignature, addTags, removeTags, replaceTags, checkDNS, startWarmup, pauseWarmup, resumeWarmup, stopWarmup, updateWarmupSettings, reactivate, delete
mailboxIdsarray

Explicit mailbox IDs to operate on

selectAllboolean

Select all mailboxes matching filters

filtersobject

Filter criteria when using selectAll

excludeIdsarray

Mailbox IDs to exclude from selection

dailySendLimitinteger

Required for updateDailyLimit operation

Min: 1 • Max: 50
signatureTemplatestring

Required for updateSignature operation. Supports \{\{firstName\}\}, \{\{lastName\}\}, \{\{email\}\} variables.

tagsarray

Required for addTags, removeTags, replaceTags operations

warmupConfigobject

Configuration for startWarmup and updateWarmupSettings operations

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

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Body

application/json
operationstring
Required

The bulk operation to perform

Allowed values:enableSendingdisableSendingupdateDailyLimitupdateSignatureaddTagsremoveTagsreplaceTagscheckDNSstartWarmuppauseWarmupresumeWarmupstopWarmupupdateWarmupSettingsreactivatedelete
mailboxIdsarray

Explicit mailbox IDs to operate on

selectAllboolean

Select all mailboxes matching filters

filtersobject

Filter criteria when using selectAll

excludeIdsarray

Mailbox IDs to exclude from selection

dailySendLimitinteger

Required for updateDailyLimit operation

signatureTemplatestring

Required for updateSignature operation. Supports \\\{\\\{firstName\\\}\\\}, \\\{\\\{lastName\\\}\\\}, \\\{\\\{email\\\}\\\} variables.

tagsarray

Required for addTags, removeTags, replaceTags operations

warmupConfigobject

Configuration for startWarmup and updateWarmupSettings operations

Responses

successboolean
dataobject