v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Journeys

Publish a journey

Publishes a journey's current draft as a new version, making it live for new runs. Pass a version instead to roll back to an earlier one.

post/journeys/{templateId}/publish

Path parameters

templateIdstring required

Journey id

Headers

Idempotency-Keystring

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

versionstring

Response

Published journey

idstring required
namestring required
state'DRAFT' | 'PUBLISHED' required

Lifecycle state of a journey.

enabledboolean required
createdinteger nullable required
creatorstring nullable required
updatedinteger nullable required
updaterstring nullable required
publishedinteger nullable required