POST/v1/postbatches/{id}/cancel

Cancel a Postbatch

Allowed in DRAFT, IMPORTING, VALIDATED, PENDING_APPROVAL and APPROVED: the open items are cancelled and their reservations released; answers invalid_postbatch_transition afterwards.

Scope postbatches.write

Path parameters

idstringrequired

Returns

18 fields of the 200 answer

idstringrequired

namestringrequired

campaignIdstring or nullrequired

advertisingCategorystring or nullrequired

statusenumrequired

DRAFTIMPORTINGVALIDATEDPENDING_APPROVALAPPROVEDSCHEDULED_FOR_RUNIN_PRODUCTIONCOMPLETEDCANCELLED

templateIdstringrequired

templateVersionIdstringrequired

productobjectrequired

4 fields

idstringrequired

specificationIdstringrequired

finishstringrequired

destinationstringrequired

countsobjectrequired

importIdstring or nullrequired

approvedAtdate-time or nullrequired

targetRunIdstring or nullrequired

priceSnapshotIdstring or nullrequired

itemCountAtApprovalinteger or nullrequired

cancelledAtdate-time or nullrequired

completedAtdate-time or nullrequired

createdAtdate-timerequired

updatedAtdate-timerequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postbatches.cancel('pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

{ "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "campaignId": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "advertisingCategory": "Example", "status": "COMPLETED", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "templateVersionId": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "product": { "id": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "specificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "destination": "Example" }, "counts": { "key": 1 }, "importId": "ipt_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "approvedAt": "2026-10-16T09:14:02.000Z", "targetRunId": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "priceSnapshotId": "ps_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "itemCountAtApproval": 3, "cancelledAt": "2026-10-16T09:14:02.000Z", "completedAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z" }