Batches

Cancel a batch

Items not released yet are canceled; released renders are canceled when a worker picks them up (items already rendering may still finish and are counted). The batch is canceled at once and batch.completed fires. Canceled items are not billed.

post/v1/batches/{batch_id}/cancel

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/batches/{batch_id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

batch_idstring required

Batch id (bat_…).

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Response

canceledinteger
completed_atstring date-time nullable
created_atstring date-time required
failedinteger
idstring required
metadataobject
object'batch' required
pendinginteger

Items without a final status yet.

progressnumber

Finished items ÷ total.

referencestring nullable
status'queued' | 'processing' | 'completed' | 'failed' | 'canceled' required
succeededinteger
template_idstring
template_versioninteger nullable

Version number rendered.

testboolean required
totalinteger required

Example response

{
  "error": {
    "code": "item_files_expired"
  },
  "files": [
    {
      "bytes": 1843200,
      "content_type": "application/zip",
      "file_id": "file_01J9ZM1X3F7R8K2C4V6B8N0P2R",
      "filename": "certificates.zip"
    }
  ],
  "id": "bat_01J9ZN4T6V8X0Z2B4D6F8H0K2M",
  "template_id": "tpl_01J9ZK3M7Q8V5W2X4Y6Z8A0B1C"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.