Schedule Batch API - Bolna Docs

POST

batches

{batch_id}

schedule

cURL

curl --request POST \
  --url https://api.bolna.ai/batches/{batch_id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form scheduled_at=2024-06-04T22:40:00.000Z \
  --form bypass_call_guardrails=false

{
  "message": "success",
  "state": "scheduled"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id

string<uuid>

required

The ID of the batch

Body

multipart/form-data

scheduled_at

string

required

The scheduled date and time in ISO 8601 format with time zone

Example:

"2024-06-04T22:40:00.000Z"

bypass_call_guardrails

boolean

default:false

Skip time validation for all calls in this batch

Response

Successful response

Stop batchUnderstand how to stop a running batch using its ID, allowing you to halt ongoing calls in the batch.

⌘I

cURL

curl --request POST \
  --url https://api.bolna.ai/batches/{batch_id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form scheduled_at=2024-06-04T22:40:00.000Z \
  --form bypass_call_guardrails=false

{
  "message": "success",
  "state": "scheduled"
}