Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

API key authentication.

X-User-ID
string
header
required

Required user id for API key requests.

Body

application/json
name
string
required
assistant_id
string
required
phone_number_id
string
required
channel
enum<string>
default:twilio
Available options:
twilio,
vobiz
scheduleStartTime
string | null
scheduleEndTime
string | null
max_concurrency
integer
default:5
Required range: 1 <= x <= 200
retry_policy
Retry Policy · object
speech_settings
SpeechSettings · object | null
campaign_context
string | null
opening_message_template
string | null
use_returning_greeting
boolean
default:false
use_short_term_summaries
boolean
default:false
short_term_summaries_limit
integer | null
machine_detection_timeout_seconds
integer | null

Voicemail/AMD detection timeout (seconds). Overrides assistant default. Single setting for all providers.

Required range: 3 <= x <= 60
recipient_list_id
string | null

ID of recipient list to attach. Include in request body when creating a campaign with a list.

recipients
RecipientPayload · object[] | null

Response

Successful Response

id
string
required
name
string
required
assistant_id
string
required
channel
string
required
phone_number_id
string
required
status
string
required

Read-only. Server-managed: draft | running | paused | completed

max_concurrency
integer
required
retry_policy
Retry Policy · object
required
speech_settings
SpeechSettings · object
required
assistant_name
string | null
caller_id_number
string | null
schedule_start_time
string | null
schedule_end_time
string | null
campaign_context
string | null
opening_message_template
string | null
use_returning_greeting
boolean
default:false
use_short_term_summaries
boolean
default:false
short_term_summaries_limit
integer | null
machine_detection_timeout_seconds
integer | null
recipient_list_id
string | null
recipient_list_name
string | null
recipient_list_row_count
integer | null
counts
Counts · object | null
created_at
string | null
updated_at
string | null