Stop Batch API

POST

batches

{batch_id}

stop

curl --request POST \
  --url https://api.bolna.dev/batches/{batch_id}/stop \
  --header 'Authorization: Bearer <token>'

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

Authorization

string

header

required

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

batch_id

string

required

The ID of the batch

200

application/json

batch status response

The response is of type any.

curl --request POST \
  --url https://api.bolna.dev/batches/{batch_id}/stop \
  --header 'Authorization: Bearer <token>'

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