Broadcasts

List broadcasts

Get a list of broadcasts for a specific org.

get/orgs/broadcasts

Request

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

Query parameters

type'ALL' | 'MARKETING' | 'TRANSACTIONAL'

Only broadcasts of this type.

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

Only broadcasts in this status.

searchstring

Filter broadcasts by name

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

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.