Sign in
Escorts

Start a new coaching period (escort) for a trainee. The plan ids required depend on escortType: "Training" needs trainingPlanId, "Nutrition" needs nutritionMenuId, "Nutrition and training" needs both, and "Other" needs neither. Create the plan or menu first (POST /training-plans, POST /nutrition-menus) and pass its id here. A trainee may only have one active escort at a time.

post/api/public/escorts

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 required
escortType'Nutrition' | 'Training' | 'Nutrition and training' | 'Other' required

Determines which plan ids are required: Training -> trainingPlanId, Nutrition -> nutritionMenuId, Nutrition and training -> both, Other -> none.

startDatestring required

ISO date.

endDatestring

ISO date. Provide this or months.

monthsnumber

Duration in months. Provide this or endDate.

goalstring
pricenumber
paymentDatestring
paymentMethod'Cash' | 'Credit card' | 'Bank transfer' | 'Other'
paymentNumbernumber
escortMeetingType'Online' | 'In person'
onlineEscortstring
inPersonEscortstring
notesstring

Optional first note on the coaching period.

cardioDaysnumber
cardioTimenumber
trainingDaysnumber
dailyStepsTargetnumber
trainingPlanIdstring

Assign an existing training plan. Required when escortType is "Training" or "Nutrition and training".

nutritionMenuIdstring

Assign an existing nutrition menu. Required when escortType is "Nutrition" or "Nutrition and training".

Response

Created

Changes

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