Campaigns

Cancel a campaign

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.

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

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/campaigns/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: campaigns:write)

Path parameters

idstring uuid required

Resource id.

Response

The cancelled campaign

audience_type'ALL' | 'FILTERED' | 'SEGMENT' | 'LIST' required
created_atstring date-time required
idstring uuid required
list_idstring uuid nullable required
namestring required
scheduled_atstring date-time nullable required
sent_atstring date-time nullable required
status'DRAFT' | 'SCHEDULED' | 'SENDING' | 'PAUSED' | 'SENT' | 'CANCELLED' required
subjectstring required
topic_idstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.