Skip to main content
POST
Create a batch

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Required. A retry with the same key and body replays the stored 2xx response; the same key with a different body is 409. A failed attempt releases the key.

Required string length: 8 - 255

Body

application/json
name
string
required
Maximum string length: 200
assistantId
string<uuid>
required

The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.

concurrency
integer
default:10
Required range: 1 <= x <= 100
retry
object
window
object | null

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

suppress
string[]

E.164 numbers this batch must never dial.

from
object
rows
object[]
Maximum array length: 10000
startPaused
boolean
default:false

Response

Accepted. Idempotent-Replay: true on a replay.

batch
object
accepted
integer
rejected
object[]