Create a journey (POST /api/public/journeys)

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

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Header parameters

Header parameters
Name	Type	Description
`Idempotency-Key`	`string`	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

application/json, required

Request body fields
Name	Type	Description
`title`required	`string`	Journey name shown to the coach.
`description`	`string`
`autoAssign`	`boolean`	Automatically enroll trainees that match the filters below.
`autoAssignPriority`	`integer`	Lower runs first when several journeys match.
`anchorType`	`string`	Whether day counting starts from the escort start date or from the moment the trainee is enrolled. Allowed values: `escort_start` `enrollment`
`filterLabels`	`string[]`	Only auto-enroll trainees with these label ids. Maximum items: `100`
`filterEscortTypes`	`string[]`	Maximum items: `100`
`filterGender`	`string[]`	Maximum items: `100`
`durationWeeks`	`integer`	Minimum: `1`
`matchByDuration`	`boolean`
`steps`	`object[]`	The ordered steps of the journey. Omit to create an empty journey and add its steps later. Maximum items: `50`
`steps[].id`	`string`	Id of an existing step, as returned by `GET /journeys/:journeyId`. Send it back to update that step in place; omit it to add a new one.
`steps[].order`required	`integer`	Position of the step within the journey, starting at 1. Minimum: `1`
`steps[].title`required	`string`	Maximum length: `200`
`steps[].triggerType`required	`string`	Whether the step fires on a day, on a week, or on an event. Allowed values: `day` `week` `event`
`steps[].triggerValue`required	`integer`	Day number for triggerType "day", week number for "week". Counted from the journey anchor, starting at 1. Minimum: `1`
`steps[].timeOfDay`	`string`	Local send time as HH:mm, e.g. "09:00".
`steps[].eventType`	`string`	Required when triggerType is "event". Allowed values: `weight_stall` `trainee_inactive` `form_submitted` `task_completed`
`steps[].eventThreshold`	`integer`	Minimum: `1`
`steps[].condition`	`object`	Optional gate: the step only fires for trainees who match it.
`steps[].condition.type`	`string`	Allowed values: `workouts_completed_in_last_days` `nutrition_logs_in_last_days` `forms_submitted_since_enrollment` `has_label` `no_label`
`steps[].condition.operator`	`string`	Allowed values: `gte` `lte` `eq`
`steps[].condition.value`	`number`
`steps[].condition.timeframeDays`	`integer`	Minimum: `1`
`steps[].condition.labelId`	`string`
`steps[].actions`	`object[]`	Maximum items: `50`
`steps[].actions[].id`	`string`	Id of an existing action on this step. Send it back to keep the action, omit it to create a new one.
`steps[].actions[].type`required	`string`	What this action does when the step fires. Allowed values: `notification` `guide` `training_plan` `nutrition_menu` `task` `whatsapp` `add_label` `remove_label` `send_form`
`steps[].actions[].notificationData`	`object`	For type "notification": { title, message, type: "push" \| "popup" \| "both", popupData? }.
`steps[].actions[].guideId`	`string`	For type "guide": the guide to reveal.
`steps[].actions[].trainingPlanId`	`string`	For type "training_plan": the plan to assign.
`steps[].actions[].nutritionMenuId`	`string`	For type "nutrition_menu": the menu to assign.
`steps[].actions[].taskData`	`object`	For type "task": { title, type, priority: "low" \| "medium" \| "high", visibleToTrainee, dueDateOffsetDays? }.
`steps[].actions[].whatsappData`	`object`	For type "whatsapp": { message, mediaUrl?, mediaType?, caption? }.
`steps[].actions[].labelId`	`string`	For types "add_label" and "remove_label": the label to apply or clear.
`steps[].actions[].replacePreviousLabels`	`boolean`
`steps[].actions[].formData`	`object`	For type "send_form": { formId, expiresAfterDays? }.

Request examples

cURL

curl --request POST \
  --url 'https://api.coach-platform.com/api/public/journeys' \
  --header 'Authorization: Bearer cp_live_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>"
}'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/journeys', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer cp_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "title": "<string>"
  }),
});

const data = await response.json();

Responses

`201` Created

Example body (application/json)

{
  "data": {},
  "warnings": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Response fields (4)

Response fields
Name	Type	Description
`data`	`object`
`warnings`	`object[]`	Non-fatal problems with follow-up writes. The resource was created, but each listed field was not applied.
`warnings[].field`	`string`
`warnings[].message`	`string`

Error responses

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
429 Too Many Requests
500 Internal Server Error

These statuses share the same response body.

Example body (application/json)

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}

Error fields (6)

Error fields
Name	Type	Description
`error`	`object`
`error.code`	`string`
`error.message`	`string`
`error.fix`	`string \| null`
`error.details`	`object \| null`
`error.retryAfterMs`	`number \| null`

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.