Create broadcast
Create a new broadcast for the organization.
Authorizations
Bearer token authentication using your API key
Path Parameters
The ID of the org
Body
Schema for creating a broadcast
The name of the broadcast
1 - 255MARKETING (bulk send to segments or all contacts, default) or TRANSACTIONAL (single-recipient sends fired by triggers). Cannot be changed after creation.
MARKETING, TRANSACTIONAL Whether sent messages appear as conversations in the Inbox.
When to send a marketing broadcast (ISO 8601 datetime). Leave empty to send immediately once scheduled.
Spread the marketing send over this many minutes instead of all at once.
The segments to include in the broadcast
10Send to every contact instead of segments. Cannot be combined with segments.
Response
Schema for a broadcast
The mode of the broadcast: MARKETING (bulk to many people) or TRANSACTIONAL (single-recipient trigger across channels)
MARKETING, TRANSACTIONAL The status of the broadcast
DRAFT, SCHEDULED, SENDING, SENT, CANCELLED, FAILED, ACTIVE, PAUSED Provider-wide send pause on this broadcast — sending resumes automatically