Forms

POST /api/public/updates/{updateId}/respond

Changed on

Respond to a submitted check-in. Accepts any id returned by GET /updates or GET /forms/registration, resolving it to a form response or a legacy update record and applying the same review flow the dashboard uses: the record is marked Handled, coachNotes, feedback and rating are stored, and target changes (trainingDays, cardioDays, cardioTime, dailyStepsTarget, nutritionNotes) update the active coaching period. customTrainingPlan and customNutritionPlan switch the active plan or menu to the given id. Feedback is delivered to the trainee as an in-app notification by default; setting notificationChannel to whatsapp or both, or supplying whatsappMessage, sends WhatsApp and additionally requires the messaging:send scope.

Request

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

Path parameters

updateIdstring 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

coachNotesstring

Private note, never shown to the trainee.

feedbackstring

Feedback text delivered to the trainee.

ratinginteger
trainingDaysinteger
cardioDaysinteger
cardioTimeinteger

Weekly cardio goal in minutes (total for the week).

dailyStepsTargetinteger
nutritionNotesstring
customTrainingPlanstring

Training plan id to switch the coaching period to.

customNutritionPlanstring

Nutrition menu id to switch the coaching period to.

saveFeedbackToTraineeboolean
notificationChannel'notification' | 'whatsapp' | 'both'

How to deliver the feedback. Defaults to notification (in-app). whatsapp and both require the messaging:send scope.

whatsappMessagestring

WhatsApp text to send instead of the feedback text. Requires the messaging:send scope.

Response

Successful response

Changes