Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json
name
string
required
audienceId
string<uuid>
required
assistantId
string
required
concurrency
integer
retry
object
window
object | null

When this batch may dial — outside it, rows wait rather than fail.

fromStrategy
string
fromNumbers
string[]
fromWeights
object | null
variables
object

Assistant variable -> contact field or attr:<key>.

blockSize
integer | null

Dial the audience in blocks of this size, one at a time.

startAt
string<date-time> | null

Response

Created, not launched.

id
string<uuid>
name
string
audienceId
string<uuid>
assistantId
string
status
string

Derived from the underlying batch on every read, never stored — so the two can never disagree.

batchId
string<uuid> | null
startAt
string<date-time> | null
createdAt
string<date-time>