Journeys
PATCH /api/public/journeys/{journeyId}
Changed onUpdate 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 URLhttps://api.coach-platform.com
- AuthHTTP 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
Response
Successful response
Changes
- breaking
added
subschema #1to the/request propertyallOflist - info
added the new
escort_progressenum value to the request property//
- breaking
- info
added the new optional request property
- info