Journeys

POST /api/public/journeys

Changed on

Create a customer journey, optionally with its ordered steps. Trainees are only enrolled once the journey is active.

Request

  • Base URL
    https://api.coach-platform.com
  • Auth
    HTTP bearer

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

    • breaking

      added subschema #1 to the / request property allOf list

    • info

      added the new escort_progress enum value to the request property //

    • info

      added the new optional request property