Broadcasts

Cancel a broadcast

Cancels a scheduled or in-flight broadcast. Recipients already handed to the email provider will still receive it; the rest are dropped, and the stats collected so far are kept.

post/broadcasts/{id}/cancel

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/broadcasts/{id}/cancel
  • Auth: API key in header Authorization

Path parameters

idstring required

The broadcast's prefixed id (e.g. bcst_abc123).

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Response

The canceled broadcast

objectstring required
idstring required
subjectstring nullable required
preview_textstring nullable required
bodystring nullable required
html_bodystring nullable required
fromstring nullable required
reply_tostring nullable required
styledboolean required
audienceobject required
audience_descriptionstring required
status'draft' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'failed' required
scheduled_atstring date-time nullable required
started_atstring date-time nullable required
sent_atstring date-time nullable required
canceled_atstring date-time nullable required
statsobject required
errorstring nullable required
metadataobject required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.