Exercises

PATCH /api/public/exercises/{exerciseId}/settings

Changed on

Change the coach's global settings for one exercise, the same settings as the exercise library in the dashboard. Only supplied fields change. They apply to every training plan and every trainee that uses the exercise; to change an exercise inside one plan only, update that plan instead. To add alternatives without touching the existing ones send addAlternativeExercises; to drop specific ones send removeAlternativeExercises. alternativeExercises REPLACES the whole list ([] clears it); when that would remove existing alternatives the request is rejected with 409 CONFLICT listing them in details.removedAlternatives, and goes through only when resent with confirmRemoveAlternatives: true. An empty string clears notes or videoLink.

Request

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

Path parameters

exerciseIdstring required

Exercise catalog id from GET /exercises.

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

notesstring

Coach notes shown to trainees on this exercise. Empty string clears.

videoLinkstring

Demonstration video URL (http/https). Empty string clears.

mediaDisplay'gif' | 'thumbnail'

"gif" shows the GIF (tapping it opens the video); "thumbnail" shows the YouTube thumbnail instead and needs a YouTube videoLink.

trackRm1boolean

Track an estimated 1RM (Brzycki) for this exercise.

isFavoriteboolean

Mark or unmark as a coach favorite.

addAlternativeExercisesstring[]

Exercise ids (from GET /exercises) to add to the current default alternatives. Existing alternatives are kept.

removeAlternativeExercisesstring[]

Exercise ids to remove from the current default alternatives. The rest are kept.

alternativeExercisesstring[]

Full list of default alternative exercise ids. Replaces the current list; [] clears it. Removing existing alternatives this way needs confirmRemoveAlternatives: true. Cannot be combined with addAlternativeExercises / removeAlternativeExercises.

confirmRemoveAlternativesboolean

Confirms that alternativeExercises may remove existing alternatives. Send only after the coach approved the removal.

Response

Successful response

Changes