Skip to main content
POST
/
orgs
/
{org_id}
/
broadcasts
Create a Broadcast
curl --request POST \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "segment_ids": [
    "<string>"
  ],
  "send_to_all": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "DRAFT",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "contacts_count": 123,
  "recipients_count": 123,
  "skipped_count": 123,
  "sent_count": 123,
  "failed_count": 123,
  "delivered_count": 123,
  "opened_count": 123,
  "played_count": 123,
  "click_count": 123,
  "complained_count": 123,
  "unsubscribed_count": 123,
  "error_message": "<string>",
  "segments": [
    {
      "id": "<string>",
      "name": "<string>",
      "contacts_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "send_to_all": true,
  "templates": [
    {
      "id": "<string>",
      "broadcast_id": "<string>",
      "connection_id": "<string>",
      "integration_id": "internal",
      "recipients_count": 123,
      "config": {},
      "error": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
org_id
string
required

The ID of the org

Body

Schema for creating a broadcast

​
name
string
required

The name of the broadcast

Required string length: 1 - 255
​
scheduled_at
string<date-time> | null

When to send the broadcast. Use null to send immediately.

​
segment_ids
string[]

The segments to include in the broadcast

Maximum array length: 10
​
send_to_all
boolean

Whether to send the broadcast to all contacts or only to the segments

Response

200 - application/json

Schema for a broadcast

​
id
string
required
​
name
string
required
​
status
enum<string>
required

The status of the broadcast

Available options:
DRAFT,
SCHEDULED,
SENDING,
SENT,
CANCELLED,
FAILED
​
scheduled_at
string<date-time> | null
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
contacts_count
number
required
​
recipients_count
number
required
​
skipped_count
number
required
​
sent_count
number
required
​
failed_count
number
required
​
delivered_count
number
required
​
opened_count
number
required
​
played_count
number
required
​
click_count
number
required
​
complained_count
number
required
​
unsubscribed_count
number
required
​
error_message
string | null
required
​
segments
object[]
required
​
send_to_all
boolean
required
​
templates
object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required