POST/v1/postbatches/{id}/approve

Approve a Postbatch

Pins the template version, locks the quote in a price snapshot, reserves the balance or checks the credit for the whole quote, and moves every valid item to READY for the next planned run or a later planned run of the product group (targetRunId). Items that need attention are skipped only with skipInvalid.

Scope postbatches.approve

Path parameters

idstringrequired

Body

targetRunIdstringmin length 1max length 40

skipInvalidbooleandefault false

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

422Validation failed

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

otherError (RFC 9457 problem details)

curl -X POST https://api.postbuddy.nl/v1/postbatches/pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K/approve \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "targetRunId": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "skipInvalid": true }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postbatches.approve('pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K', { body: { targetRunId: 'run_01J9Y2K8QF4T6W8Z0B2D4F6H8K', skipInvalid: true, }, });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.postbatches.approve("pb_01J9Y2K8QF4T6W8Z0B2D4F6H8K", { "targetRunId": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "skipInvalid": True, })

{ "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" }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }