Broadcast

idstringrequired

namestring

statusBroadcastStatusrequired

Possible values: [draft, scheduled, sending, paused, cancelled, completed]

subjectstringrequired

fromstringrequired

from_namestring

audience_idsstring[]

Tag ids the broadcast is addressed to. Empty means every subscribed contact.

scheduled_atstring<date-time>

sent_atstring<date-time>

total_recipientsinteger<int64>

stats object

acceptedinteger<int64>

deliveredinteger<int64>

failedinteger<int64>

bouncedinteger<int64>

unique_opensinteger<int64>

unique_clicksinteger<int64>

created_atstring<date-time>required

updated_atstring<date-time>required

Broadcast

{
  "id": "string",
  "name": "string",
  "status": "draft",
  "subject": "string",
  "from": "string",
  "from_name": "string",
  "audience_ids": [
    "string"
  ],
  "scheduled_at": "2024-07-29T15:51:28.071Z",
  "sent_at": "2024-07-29T15:51:28.071Z",
  "total_recipients": 0,
  "stats": {
    "accepted": 0,
    "delivered": 0,
    "failed": 0,
    "bounced": 0,
    "unique_opens": 0,
    "unique_clicks": 0
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}