broadcast

idinteger

titlestring

account_idinteger

channel_typestring

inboxobject

The inbox the messages go out from

messagestring

Legacy single-message body, superseded by the queue in messages

template_paramsobject

messages object[]

The queue, sent in order

Array [

idinteger

positioninteger

message_kindstring

text, media or template

contentstring

template_paramsobject

delay_secondsinteger

Wait after the previous step

media object

Present on a media step

filenamestring

content_typestring

]

audience_typestring

segment resolves a filter, manual_import uses ids from an import, and saved points at an audience.

Possible values: [segment, manual_import, saved]

audience_idinteger

The saved audience, when audience_type is saved

segment_queryobject

The filter, when audience_type is segment

ai_configobject

statusstring

Possible values: [draft, scheduled, queued, running, paused, completed, failed, canceled]

scheduled_atinteger

Unix timestamp. A launch with this in the future schedules instead of sending.

messages_per_secondinteger

Throttle, so a provider is not flooded

batch_sizeinteger

batch_delayinteger

recipients_countinteger

Zero until the audience is materialized by the launch

sent_countinteger

failed_countinteger

progress_percentagenumber

started_atinteger

completed_atinteger

created_atinteger

updated_atinteger

broadcast

{
  "id": 0,
  "title": "string",
  "account_id": 0,
  "channel_type": "string",
  "inbox": {},
  "message": "string",
  "template_params": {},
  "messages": [
    {
      "id": 0,
      "position": 0,
      "message_kind": "string",
      "content": "string",
      "template_params": {},
      "delay_seconds": 0,
      "media": {
        "filename": "string",
        "content_type": "string"
      }
    }
  ],
  "audience_type": "segment",
  "audience_id": 0,
  "segment_query": {},
  "ai_config": {},
  "status": "draft",
  "scheduled_at": 0,
  "messages_per_second": 0,
  "batch_size": 0,
  "batch_delay": 0,
  "recipients_count": 0,
  "sent_count": 0,
  "failed_count": 0,
  "progress_percentage": 0,
  "started_at": 0,
  "completed_at": 0,
  "created_at": 0,
  "updated_at": 0
}