Broadcasts

Cancel broadcast

Cancel a broadcast, returning it to DRAFT so it can be edited and sent again. Can only cancel broadcasts in SCHEDULED or SENDING status. Cancelling a live send keeps the messages already delivered and discards the unsent remainder; a later send skips every contact that already received it.

post/orgs/broadcasts/{broadcast_id}/cancel

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/broadcasts/{broadcast_id}/cancel
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

Broadcast ID

Response

idstring required
namestring required
type'MARKETING' | 'TRANSACTIONAL' required

The mode of the broadcast: MARKETING (bulk to many people) or TRANSACTIONAL (single-recipient trigger across channels)

status'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED' | 'FAILED' | 'ACTIVE' | 'PAUSED' required

The status of the broadcast

show_in_inboxboolean required
scheduled_atstring date-time nullable required
pace_minutesnumber nullable required
started_atstring date-time nullable required
completed_atstring date-time nullable required
recipients_countnumber required
queued_countnumber required
sending_countnumber required
skipped_countnumber required
sent_countnumber required
failed_countnumber required
bounced_countnumber required
delivered_countnumber required
opened_countnumber required
played_countnumber required
click_countnumber required
complained_countnumber required
unsubscribed_countnumber required
error_messagestring nullable required
send_to_allboolean required
created_atstring date-time required
updated_atstring date-time required

Changes

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