Skip to main content
POST
Create a draft campaign

Authorizations

lx_session
string
cookie
required

Dashboard session cookie

Body

application/json
assistant_id
string<uuid>
required
name
string
required
Required string length: 1 - 200
purpose
enum<string>
required
Available options:
informational,
telemarketing
amd_mode
enum<string>
Available options:
off,
hangup_on_machine,
voicemail
amd_profile_id
string<uuid>
cps
number<double>
Required range: x <= 50
end_at
string<date-time>
informational_category
string

Informational campaigns only: the category an opt-out on this campaign revokes (FCC 26-67). Empty means an opt-out revokes every call

Pattern: ^[a-z][a-z0-9_]{1,40}$
max_attempts
integer<int64>
Required range: 1 <= x <= 10
max_concurrent
integer<int64>
Required range: 1 <= x <= 1000
number_ids
string[]

Caller-ID pool

Maximum array length: 100
retry_policy
object
ring_timeout_s
integer<int64>
Required range: 15 <= x <= 60
start_at
string<date-time>
voicemail_message
string
Required string length: 1 - 1000
windows
object[]

Further restricts the legal calling windows

Maximum array length: 14

Response

Created

amd_mode
enum<string>
required
Available options:
off,
hangup_on_machine,
voicemail
assistant_id
string<uuid>
required
cps
number<double>
required
created_at
string<date-time>
required
created_by
string
required
id
string<uuid>
required
max_attempts
integer<int64>
required
max_concurrent
integer<int64>
required
name
string
required
number_ids
string[]
required
purpose
enum<string>
required
Available options:
informational,
telemarketing
retry_policy
object
required
ring_timeout_s
integer<int64>
required
status
enum<string>
required
Available options:
draft,
running,
paused,
completed,
archived
updated_at
string<date-time>
required
windows
object[]
required
amd_profile_id
string<uuid>
archived_at
string<date-time>
end_at
string<date-time>
informational_category
string
paused_reason
enum<string>
Available options:
user,
credits_exhausted,
window_closed,
no_caller_id,
compliance,
operator
start_at
string<date-time>
voicemail_message
string