ALalloy
Batches

Pause or Resume a Batch

Changed on

Pause a pending batch or resume a paused batch. Send paused to pause a batch that is currently pending, or pending to resume a batch that is currently paused. Any other transition returns a 409.

patch/batches/{batch_token}

Request

Request body

batch_status'pending' | 'paused' required

paused to pause a pending batch; pending to resume a paused batch.

Example request

{
  "batch_status": "paused"
}

Response

Batch status updated

status_codenumber
errorobject nullable
batch_tokenstring
batch_statusstring

Example response

{
  "status_code": 200,
  "error": null,
  "batch_token": "B-grYZsEoy623M3LiZrK66",
  "batch_status": "paused",
  "_links": {
    "batch": {
      "href": "/batches/B-grYZsEoy623M3LiZrK66"
    }
  }
}

Changes