Batches API v1Alpha

Cancel batch

Changed on

Cancel a batch.

patch/api/v1alpha/batches/{batch_id}/cancel

Request

  • Base URL: {{ base_url }}
  • URL: {{ base_url }}/api/v1alpha/batches/{batch_id}/cancel
  • Auth: none declared

Path parameters

batch_idnumber required

The ID of the batch.

Response

Successfully cancelled the batch.

successboolean

Whether the operation was successful

Example response

{
  "success": true
}

Changes