POST/v1/postflows

Create a Postflow

The product follows from the template; the template needs a published version. Pause, resume, archive, stats and the list arrive with the next release.

Scope postflows.writeIdempotent with a key

Headers

Idempotency-Keystringmax length 255

Up to 255 characters, scoped to the organisation and the endpoint, kept for 24 hours: a repeat with the same body replays the stored response with Idempotent-Replayed: true (API-004).

Body

namestringrequiredmin length 1max length 160

descriptionstringmax length 2000

templateIdstringrequiredmin length 1

versionPolicyenumdefault "LATEST_PUBLISHED"

LATEST_PUBLISHEDPINNED

pinnedVersionIdstringmin length 1

finishstringrequiredmin length 1max length 40

destinationstringmin length 2max length 2default "NL"

dispatchobjectdefault {"strategy":"IMMEDIATE","strictMinimum":false}

4 fields

strategyenumdefault "IMMEDIATE"

IMMEDIATESEND_DATEMIN_COUNT_MAX_WAIT

minCountintegermin 1max 1000000

maxWaitDaysintegermin 1max 365

strictMinimumbooleandefault false

requiresApprovalboolean

advertisingCategorystring or null

Returns

16 fields of the 201 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

201Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

409A request with this Idempotency-Key is still in progress (idempotency_in_progress)

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 \ -H "Authorization: Bearer $POSTBUDDY_API_KEY" \ -H "Idempotency-Key: crm-0062p00001Xyz-signed" \ -H "Content-Type: application/json" \ -d '{ "name": "Welcome card", "description": "Welcome card for new customers", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk" }'

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.postflows.create({ body: { name: 'Welcome card', description: 'Welcome card for new customers', templateId: 'tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K', finish: 'silk', },, idempotencyKey: 'crm-0062p00001Xyz-signed', });

import os from postbuddy import Client client = Client(os.environ["POSTBUDDY_API_KEY"]) result = client.postflows.create({ "name": "Welcome card", "description": "Welcome card for new customers", "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "finish": "silk", }, idempotency_key="crm-0062p00001Xyz-signed")

{ "id": "pf_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/idempotency_in_progress", "title": "Request with this idempotency key in progress", "status": 409, "code": "idempotency_in_progress", "detail": "A request with this Idempotency-Key is still in progress (idempotency_in_progress)", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K" }

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