API reference
Every operation of the public API, generated from the OpenAPI document (145 operations, version 1.0.0).
Base URL
https://api.postbuddy.nlAuthentication
Authorization: Bearer pb_live_… or a pb_test_ key. AuthenticationErrorsProblem details with a stable code. Error codes
Lists and limitsPagination and filters, rate limits, the raw openapi.json
Items
POSTCreate an item in a Postflow
/v1/postflows/{id}/itemsGETList items/v1/itemsGETList the status history of an item/v1/items/{id}/eventsGETList the QR scans of an item/v1/items/{id}/scansGETGet an item/v1/items/{id}PATCHRepair or edit an item/v1/items/{id}POSTCancel an item/v1/items/{id}/cancelGETProduction PDF of an item/v1/items/{id}/pdfGETPreview images of an item/v1/items/{id}/previewPOSTRepair several items with the same patch/v1/items/bulk-repairPostflows
POSTCreate a Postflow
/v1/postflowsGETList Postflows/v1/postflowsGETGet a Postflow/v1/postflows/{id}PATCHUpdate a Postflow/v1/postflows/{id}POSTApprove pending items of a Postflow/v1/postflows/{id}/approvalsPOSTArchive a Postflow/v1/postflows/{id}/archivePOSTPause a Postflow/v1/postflows/{id}/pausePOSTResume a Postflow/v1/postflows/{id}/resumeGETPostflow statistics/v1/postflows/{id}/statsPostbatches
POSTCreate a Postbatch
/v1/postbatchesGETList Postbatches/v1/postbatchesGETList the items of a Postbatch/v1/postbatches/{id}/itemsGETGet a Postbatch/v1/postbatches/{id}PATCHRename a Postbatch or change its campaign/v1/postbatches/{id}POSTApprove a Postbatch/v1/postbatches/{id}/approvePOSTCancel a Postbatch/v1/postbatches/{id}/cancelGETImport status/v1/postbatches/{id}/importPOSTUpload the CSV of a Postbatch/v1/postbatches/{id}/importPOSTCancel the import/v1/postbatches/{id}/import/cancelPUTConfirm the mapping/v1/postbatches/{id}/import/mappingPOSTProcess the import/v1/postbatches/{id}/import/processGETImport progress stream/v1/postbatches/{id}/import/progressGETImport rows that did not become items/v1/postbatches/{id}/import/rowsPOSTKeep a duplicate row/v1/postbatches/{id}/import/rows/{rowId}/keepGETMapping targets and presets of the template/v1/postbatches/{id}/mapping-presetsPOSTProof PDF of a sample item/v1/postbatches/{id}/proofGETQuote of a Postbatch/v1/postbatches/{id}/quotePOSTRequest approval/v1/postbatches/{id}/request-approvalPOSTSkip the items that need attention/v1/postbatches/{id}/skip-attentionTemplates
POSTCreate a template folder
/v1/template-foldersPOSTCreate a template with an empty draft/v1/templatesGETList template folders/v1/template-foldersGETList templates/v1/templatesGETList template versions/v1/templates/{id}/versionsGETGet a template/v1/templates/{id}GETGet the draft document and its revision/v1/templates/{id}/draftGETGet a template version with its document and variable schema/v1/templates/{id}/versions/{number}PATCHRename or move a template folder/v1/template-folders/{id}PATCHRename or move a template/v1/templates/{id}DELETEArchive a template/v1/templates/{id}PUTSave the draft document/v1/templates/{id}/draftPOSTDuplicate a template/v1/templates/{id}/duplicatePOSTPublish the draft as a new version/v1/templates/{id}/publishPOSTOrder a physical sample of a version/v1/templates/{id}/versions/{number}/samplesDELETEDelete a template folder/v1/template-folders/{id}Mapping presets
POSTCreate a mapping preset
/v1/templates/{id}/mapping-presetsGETList mapping presets of a template/v1/templates/{id}/mapping-presetsPATCHUpdate a mapping preset/v1/templates/{id}/mapping-presets/{pid}POSTSuggest a mapping for CSV headers/v1/templates/{id}/mapping-presets/suggestDELETEDelete a mapping preset/v1/templates/{id}/mapping-presets/{pid}Media
Uploads
POSTCreate an upload session with a presigned PUT URL
/v1/uploadsGETList image assets/v1/assetsGETList organisation fonts/v1/fontsGETGet an image asset with signed URLs/v1/assets/{id}GETGet an organisation font/v1/fonts/{id}GETGet an upload session/v1/uploads/{id}POSTComplete an upload session/v1/uploads/{id}/completeDELETEDelete an image asset/v1/assets/{id}DELETEDelete an organisation font/v1/fonts/{id}Renders
Products
Suppressions
GETList suppression entries
/v1/suppressionsGETGet a suppression entry/v1/suppressions/{id}POSTAdd suppression entries/v1/suppressionsPATCHChange a suppression entry/v1/suppressions/{id}POSTImport suppression entries from a CSV upload/v1/suppressions/importDELETERemove a suppression entry/v1/suppressions/{id}Webhooks
POSTCreate a webhook endpoint
/v1/webhooksGETList webhook endpoints/v1/webhooksGETGet an event/v1/events/{id}GETGet a webhook endpoint/v1/webhooks/{id}GETEvent feed/v1/eventsPATCHUpdate a webhook endpoint/v1/webhooks/{id}GETDelivery log of an endpoint/v1/webhooks/{id}/deliveriesPOSTReplay a delivery/v1/webhooks/{id}/deliveries/{deliveryId}/replayPOSTReplay the events missed while disabled/v1/webhooks/{id}/replay-missedPOSTSend a test event/v1/webhooks/{id}/testDELETEDelete a webhook endpoint/v1/webhooks/{id}Integrations
GETList installations
/v1/integrations/installationsGETGet an installation with its activity/v1/integrations/installations/{id}GETIntegration apps/v1/integrations/appsPOSTInstall an integration/v1/integrations/apps/{appKey}/installationsPATCHUpdate an installation/v1/integrations/installations/{id}POSTDisable an installation/v1/integrations/installations/{id}/disablePOSTEnable an installation/v1/integrations/installations/{id}/enablePOSTRun the health check/v1/integrations/installations/{id}/healthDELETERemove an installation/v1/integrations/installations/{id}Exports
Analytics
Billing
GETList invoices and credit notes
/v1/billing/invoicesGETAn invoice with its lines/v1/billing/invoices/{id}GETA signed download link for the invoice PDF/v1/billing/invoices/{id}/pdfGETLedger entries/v1/billing/ledgerGETPayments/v1/billing/paymentsPOSTCancel a pending top-up request/v1/billing/payments/{id}/cancelGETYour prices/v1/billing/pricesGETThe usage statement of a month/v1/billing/statements/{month}GETBilling summary/v1/billing/summaryPOSTRequest a top-up/v1/billing/top-upsPOSTQuote a price/v1/quotes