Sign in
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

Changes

Changed in 6 of the 55 revisions of this API.35

  • 04f69fbf96a51See the full diff
    • ○

      added the optional property nodes/items/oneOf[subschema #3: Send]/message/context to the response with the 200 status

      response-optional-property-added

  • f76bed79a9132See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the new optional header request parameter x-idempotency-expiration

      new-optional-request-parameter

  • 79d88e92764411See the full diff
    • ▲

      the response property nodes/items/oneOf[subschema #3: Send]/message/template became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property nodes/items/oneOf[subschema #3: Send]/experiment to the response with the 200 status

      response-optional-property-added

  • b07d3a8aa2fe1See the full diff
    • ▲

      added JourneyAddToDigestNode to the nodes/items/ response property oneOf list for the response status 200

      response-property-one-of-added

  • 4a6bb54f79751See the full diff
    • ▲

      added JourneyBatchNode to the nodes/items/ response property oneOf list for the response status 200

      response-property-one-of-added

  • ecf876c6cda31See the full diff
    • ○

      endpoint added

      endpoint-added