Sign in
Batches API v1Alpha

Cancel batch

Cancel a batch.

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

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

Changed in 2 of the 9 revisions of this API.11

  • afa3b61d1d091See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 559a91071cc11See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog