Sign in
Journeys

Create a customer journey. The journey is created without steps; add and order its steps in the Coach UI, then activate it. Trainees are only enrolled once the journey is active.

post/api/public/journeys

Headers

Idempotency-Keystring

Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request body

titlestring required

Journey name shown to the coach.

descriptionstring
autoAssignboolean

Automatically enroll trainees that match the filters below.

autoAssignPriorityinteger

Lower runs first when several journeys match.

anchorType'escort_start' | 'enrollment'

Whether day counting starts from the escort start date or from the moment the trainee is enrolled.

filterLabelsstring[]

Only auto-enroll trainees with these label ids.

filterEscortTypesstring[]
filterGenderstring[]
durationWeeksinteger
matchByDurationboolean

Response

Created

dataobject

Changes

No recorded changes to this endpoint across all 1 revision of this API.