POST/v1/postflows/{id}/archive

Archive a Postflow

Refused while HELD, PENDING_APPROVAL or READY items exist unless cancelItems is true, which cancels them first.

Scope postflows.write

Path parameters

idstringrequired

Body

cancelItemsbooleandefault false

Returns

16 fields of the 200 answer

idstringrequired

namestringrequired

descriptionstring or nullrequired

statusenumrequired

ACTIVEPAUSEDARCHIVED

templateIdstringrequired

versionPolicyenumrequired

LATEST_PUBLISHEDPINNED

pinnedVersionIdstring or nullrequired

productIdstringrequired

productSpecificationIdstringrequired

finishstringrequired

destinationstringrequired

dispatchobjectrequired

4 fields

strategyenumrequired

IMMEDIATESEND_DATEMIN_COUNT_MAX_WAIT

minCountinteger or nullrequired

maxWaitDaysinteger or nullrequired

strictMinimumbooleanrequired

requiresApprovalboolean or nullrequired

advertisingCategorystring 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/postflows/pf_01J9Y2K8QF4T6W8Z0B2D4F6H8K/archive \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "cancelItems": false }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postflows.archive('pf_01J9Y2K8QF4T6W8Z0B2D4F6H8K', { body: { cancelItems: false, }, });

{ "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "description": "Welcome card for new customers", "status": "ACTIVE", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "versionPolicy": "LATEST_PUBLISHED", "pinnedVersionId": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productId": "prd_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "productSpecificationId": "psp_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", "destination": "Example", "dispatch": { "strategy": "IMMEDIATE", "minCount": 3, "maxWaitDays": 1, "strictMinimum": false }, "requiresApproval": false, "advertisingCategory": "Example", "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" } ] }