Skip to main content
POST
Create a new broadcast

Authorizations

x-api-key
string
header
required

Body

application/json
agent_id
string<uuid>
required

ID of the agent to use for the broadcast

channel
enum<string>
required

Communication channel for the broadcast

Available options:
phone,
advanced-voice
prompt_id
string<uuid>
required

ID of the prompt to use for the broadcast

voice_id
string
required

ID of the voice to use for the broadcast

contact_ids
string<uuid>[]
required

Array of contact IDs to include in the broadcast

schedule_config
object
required
first_sentence
string

First sentence the agent will say

name
string

Name of the broadcast

description
string

Description of the broadcast

test
boolean

Whether this is a test broadcast

Response

Broadcast created successfully

schedule
object