Jobs

Cancel a bulk job or mail merge campaign

Bulk jobs and mail merge campaigns. A campaign that is sending stops within a few emails (202): emails already sent are charged and the rest are marked skipped with error_code: CANCELLED; a mailmerge.campaign.cancelled webhook follows.

A queued job is cancelled at once and nothing is charged (200). A bulk job that is converting stops before its next file (202): the PDFs it already made stay in its output, downloadable from /jobs/{job_id}/download, and are charged; the rest are marked skipped with error_code: CANCELLED. Keep polling GET /jobs/{job_id} until status is cancelled. A bulk.job.cancelled webhook is sent either way.

post/jobs/{job_id}/cancel

Request

Base URL: https://api.podpdf.com
URL: https://api.podpdf.com/jobs/{job_id}/cancel
Auth: API key in header X-API-Key

Response

The queued job was cancelled

job_idstring

status'cancelled' | 'processing'

cancel_requestedboolean

messagestring

Example response

{
  "job_id": "9f0a4b78-2c0c-4d14-9b8b-123456789abc",
  "cancel_requested": true,
  "message": "The job stops before its next file. PDFs already made are kept in the output and charged."
}

Changes

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