v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Journeys

Publish journey

Publish a draft journey so it goes live and starts enrolling people (this begins real outreach). Validates first and requires confirm: true. The trigger is taken from the ENTRY node. Any previously live version is retired.

post/api/v1/journeys/{journeyId}/publish

Path parameters

journeyIdstring required

A draft journey id, or the initiative id (resolves to its current draft).

Request body

confirmboolean

Must be true to publish. Publishing starts real customer outreach.

includeExistingboolean

For a segment trigger: also enroll people already in the segment (a one-time backfill).

Response

Success

idstring required

Journey (workflow version) id.

initiativeIdstring required

The initiative this journey belongs to.

status'DRAFT' | 'PUBLISHED' | 'STOPPED' required

DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).

versioninteger required

Version number within the initiative.