Skip to Content
SendlySendly
API ReferenceCampaigns

Cancel a campaign

POST
/api/v1/campaigns/{id}/cancel

Cancel a SCHEDULED, SENDING, or PAUSED campaign. Terminal — a cancelled campaign cannot be resumed or re-sent. Takes no request body.

Like every action on this resource, the response is the campaign itself, so status tells you what the transition did without a second request.

Requires the campaigns:write scope — Create, edit, and organize your campaigns.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid

Response Body

The cancelled campaign

application/json
  1. response

A campaign as exposed on the v1 API.

id*string
Formatuuid
name*string
status*string
Value in"DRAFT""SCHEDULED""SENDING""PAUSED""SENT""CANCELLED"
subject*string
audience_type*string
Value in"ALL""FILTERED""SEGMENT""LIST"
list_id*|
Formatuuid
topic_id*|
Formatuuid
scheduled_at*|
Formatdate-time
sent_at*|
Formatdate-time
created_at*string
Formatdate-time
stats*
Example Request
curl -X POST 'https://api.sendly.now/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "status": "DRAFT",  "subject": "string",  "audience_type": "ALL",  "list_id": "430bbdbc-9d7f-4d06-a273-67ca4ba4ae4b",  "topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5",  "scheduled_at": "2019-08-24T14:15:22Z",  "sent_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "stats": {    "total_recipients": 0,    "sent": 0,    "delivered": 0,    "opened": 0,    "clicked": 0,    "bounced": 0  }}