Skip to main content
POST
Create campaign

Authorizations

X-API-Key
string
header
required

API key issued for your workspace.

Body

application/json

Campaign creation request

agentId
string
required
contactListIds
string[]
required
Minimum array length: 1
fromNumber
string
required

Caller phone number in E.164 format. Mutually exclusive with numberPoolId.

maxConcurrency
integer
required
Required range: x >= 1
name
string
required
dndListIds
string[]
numberPoolId
string

Number pool used for caller ID rotation. Mutually exclusive with fromNumber.

retryPolicy
object
scheduleEnd
string
Pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
scheduleStart
string
Pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
scheduledAt
string<date-time>
sendNow
boolean
timezone
string

Response

Created

data
object
success
boolean