PricingDocsCompareGuidesBlog
API referenceCampaigns

Cancel a campaign

POST/campaigns/{id}/cancel

Stops a scheduled, sending or paused campaign for good; recipients not yet sent are never sent.

Authorization

apiKey
AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Path Parameters

id*string
Length1 <= length <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/campaigns/string/cancel"
{  "object": "campaign",  "id": "string",  "name": "string",  "status": "draft",  "from": "string",  "reply_to": [    "string"  ],  "subject": "string",  "preheader": "string",  "template_id": "string",  "template_version_id": "string",  "html": "string",  "text": "string",  "list_ids": [    "string"  ],  "segment_id": "string",  "preference_list_id": "string",  "scheduled_at": "2019-08-24T14:15:22Z",  "sent_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "stats": {    "recipients": 0,    "sent": 0,    "delivered": 0,    "opened": 0,    "clicked": 0,    "bounced": 0,    "complained": 0,    "unsubscribed": 0,    "failed": 0,    "skipped": 0  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Send or schedule a campaign POST

Sends now, or at `scheduled_at` (ISO 8601 or natural language, up to 30 days ahead). Needs from, subject, content, an audience, a verified sending domain and a physical address in the marketing settings. The audience is snapshotted when sending starts.

Pause a campaign POST

Stops a scheduled or sending campaign after the email in flight.