Journeys

POST /api/public/journeys/{journeyId}/enroll

Changed on

Enroll one trainee into an active journey. Identify them with traineeId (their active coaching period is used) or with escortId to pick a specific coaching period. A trainee already enrolled in another journey returns 409 unless replaceExisting is true. Enrollments are limited to one per second per coach, so space out loops that enroll many trainees.

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

traineeIdstring

The trainee to enroll, resolved to their active coaching period. Send this or escortId.

escortIdstring

The coaching period to enroll. Send this or traineeId when you need a specific one.

startDateShiftDaysinteger

Shift the journey start by this many days. Negative values start it in the past, so earlier steps fire immediately.

startAtStepIdstring

Begin at this step instead of the first one.

replaceExistingboolean

Cancel the trainee's current enrollment in another journey instead of returning 409.

Response

Created

dataobject

Changes