Broadcasts

Update broadcast

Update a specific broadcast by its ID. Only draft broadcasts can be updated.

patch/orgs/broadcasts/{broadcast_id}

Request

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

Path parameters

broadcast_idstring required

Broadcast ID

Request body

namestring

The name of the broadcast

show_in_inboxboolean

Whether sent messages appear as conversations in the Inbox.

scheduled_atstring date-time nullable

When to send a marketing broadcast (ISO 8601 datetime). Leave empty to send immediately once scheduled.

pace_minutesinteger nullable

Spread the marketing send over this many minutes instead of all at once.

segment_idsstring[]

The segments to include in the broadcast

send_to_allboolean

Send to every contact instead of segments. Cannot be combined with segments.

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.