Journeys

PATCH /api/public/journeys/{journeyId}

Changed on

Update a customer journey's settings and steps. Sending "steps" replaces the whole list, so read the journey first and send every step you want to keep: steps you send back with their id are updated in place, steps you leave out are removed, and steps without an id are added. Editing steps reschedules pending sends for trainees already enrolled.

Request

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

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

    • 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