Skip to main content
GET
Ruby

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The broadcast ID.

Response

OK

id
string<uuid>
required
createdAt
string<date-time>
required
status
enum<string>
required

Current processing state of a broadcast. accepted — queued, waiting for the channel to become available. processing — actively sending messages. completed — all messages have been processed. canceled — stopped before completing.

Available options:
accepted,
processing,
completed,
canceled
subject
string
required
completion
string
required
messages
integer<int32>
required
failed
integer<int32>
required

Number of messages that failed permanently. Retrieve details via GET /broadcasts/{id}/failures.

suppressed
integer<int32>
required

Number of recipients skipped because they appear on a suppression list. Retrieve details via GET /broadcasts/{id}/suppressions.

content
object
required
tracking
object
required
statistics
object
required