Sign in
Journeys

Update a customer journey's settings. Steps cannot be edited through the API: editing steps re-schedules pending sends for enrolled trainees, so it is only available in the Coach UI.

patch/api/public/journeys/{journeyId}

Path parameters

journeyIdstring required

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
descriptionstring
isActiveboolean

Activate or pause the journey.

autoAssignboolean
autoAssignPriorityinteger
anchorType'escort_start' | 'enrollment'
filterLabelsstring[]
filterEscortTypesstring[]
filterGenderstring[]
durationWeeksinteger
matchByDurationboolean

Response

Successful response

dataobject

Changes

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