Broadcasts

Cancel a scheduled broadcast

Cancel a broadcast. A scheduled broadcast is stopped before anything is sent. A queued or sending broadcast stops where it is: emails already accepted are delivered, the rest are dropped and their credits refunded

post/v1/broadcasts/{id}/cancel

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/broadcasts/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

The broadcast ID

Response

Broadcast canceled

objectstring
idstring required
namestring required
audiencestring
audience_metaAudienceMeta

Details of the audience, such as the segment_id

fromstring nullable
reply_tostring nullable
subjectstring nullable
preview_textstring nullable
htmlstring nullable
textstring nullable
markdownstring nullable
status'draft' | 'scheduled' | 'queued' | 'sending' | 'sent' | 'paused' | 'canceled' | 'failed' required
scheduled_atstring date-time nullable
queued_atstring date-time nullable
sent_atstring date-time nullable
canceled_atstring date-time nullable
archived_atstring date-time nullable

When the broadcast was archived. Archived broadcasts are left out of the list unless archived=true or archived=all.

paused_atstring date-time nullable

Set when the campaign was stopped mid-send by the deliverability guard

pause_reasonstring nullable

Why the campaign was paused, for example the complaint rate that tripped the guard

fanout_completed_atstring date-time nullable

When every recipient of the send had been created

expected_recipientsinteger nullable

Eligible recipients counted when the send was accepted

send_over_minutesinteger

Minutes the send is spread over from its start (scheduled_at, else queued_at); 0 means all at once

track_opensboolean
track_clicksboolean
recipient_countinteger
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "object": "broadcast",
  "id": "clx_broadcast123",
  "name": "May product update",
  "audience": "all_contacts",
  "audience_meta": {
    "segment_id": "clx_segment123"
  },
  "from": "updates@example.com",
  "status": "draft",
  "track_opens": true,
  "track_clicks": true,
  "recipient_count": 1250,
  "metrics": {
    "total": 1250,
    "skipped": 12,
    "handed_off": 1238,
    "sent": 1238,
    "delivered": 1202,
    "opened": 714,
    "clicked": 208,
    "unsubscribed": 3,
    "bounced": 9,
    "complained": 1,
    "delivery_rate": 97.1,
    "open_rate": 59.4,
    "click_rate": 17.3,
    "unsubscribe_rate": 0.2,
    "bounce_rate": 0.7
  }
}

Changes

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