Batches

Cancel the queued items of a batch

post/v1/batches/{id}/cancel

Request

  • Base URL: https://api.castpdf.com
  • URL: https://api.castpdf.com/v1/batches/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The id (UUID).

Response

OK

idstring uuid
status'queued' | 'processing' | 'completed' | 'canceled'
livemodeboolean
source'api' | 'spreadsheet'
template_idstring uuid
template_versioninteger
totalinteger
queuedinteger
processinginteger
succeededinteger
failedinteger
canceledinteger
created_atstring date-time
completed_atstring date-time nullable
metadataobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.