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

How many calls to run at the same time. Cannot exceed the account's calls-at-once limit (maxConcurrentCalls on GET /v1/usage) — 2 on a new account; Vodex support raises it per customer. Omitted means the account's limit, up to 10.

Required range: 1 <= x <= 100
retry
object
window
object | null

When this batch may dial — outside it, rows wait rather than fail. A row's own timezone (the timezoneField variable) wins over timezone; a row with neither fails with no_timezone.

suppress
string[]

E.164 numbers this batch must never dial.

from
object
rows
object[]
Maximum array length: 10000
startPaused
boolean
default:false
blockSize
integer | null

Dial the rows in blocks of this size, one at a time: only the first block dials, and POST /v1/batches/{id}/blocks/next clears each next one. Omitted dials the whole list at once.

Required range: 1 <= x <= 10000

Response

Accepted. Idempotent-Replay: true on a replay.

batch
object
accepted
integer
rejected
object[]