Cancel Campaign

Cancels a campaign that has not yet completed. Sendiee marks every pending / queued recipient as skipped, so the message worker immediately stops draining the rest of the audience.

POST/v2.0/campaigns/{campaignId}/cancel

Path Parameters

Path

ParameterTypeDescription
campaignIdstringCampaign id returned by POST /v2.0/campaigns

Example

curl -X POST https://api.sendiee.com/v2.0/campaigns/664a.../cancel \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "success": true,
  "message": "Campaign cancelled. Pending recipients have been skipped.",
  "data": {
    "campaignId": "664a...",
    "status": "cancelled",
    "cancelledAt": "2026-04-29T05:18:42.000Z",
    "skippedRemaining": 482
  }
}

Already terminal (409)

{
  "error": true,
  "code": "CAMPAIGN_NOT_CANCELLABLE",
  "message": "Campaign is already in terminal status \"completed\" and cannot be cancelled.",
  "details": {
    "currentStatus": "completed"
  }
}

Not Found (404)

{
  "error": true,
  "code": "CAMPAIGN_NOT_FOUND",
  "message": "Campaign not found"
}