Create Campaign

Create a new Campaign associated with a Dialpad Target

Body Params
AiAgentSettings | null
Defaults to null

AI agent settings to apply to default call rule when auto_create is True

boolean
Defaults to false

auto-create default call and sms rules with default timegate settings

length ≤ 1500

The phone number to use as caller id or local_presence

When this campaign is scheduled to end. None if never ending.

When this campaign is scheduled to start. None if start immediately.

string
length ≤ 300

Description of Campaign

integer
required

the dialpad Target id calls/texts will be associated with

boolean
Defaults to false

If the campaign should dynamically create lead list items from an audience

string
length ≤ 1500
Defaults to generated name

Campaign name for display

office_id that owns this Campaign

Bot to execute when a LeadListItem completes (saved on CampaignSettings)

queries
array of objects
length ≤ 20
Defaults to []

Snapshotted audience queries from shared list at launch time

queries (unindexed)
boolean
Defaults to false

Set the default timegate settings for the campaign

settings related to campaign

optional shared LeadList id to use as template

string
enum
length ≤ 1500
Defaults to progressive

Dialing strategy for the campaign

Allowed:
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json