Loki Docs
Tools › Workouts › Create a workout template

Create a workout template

create_workout_templateAdds
What it does
Adds a new record and leaves what you had alone.
Permission
Workouts, change workouts:write

What your assistant is told

Create a new workout template for the calling user. Exercises are referenced by exercise — a catalog slug or a numeric id (from find_exercises). Returns the new template's id.

Parameters

  • nametext, requiredDisplay name, e.g. "Thursday Pull".
  • exerciseslist of object, requiredOrdered list of exercises with their planned sets.
  • notestext, optionalOptional free-text note shown on the template.
  • positionwhole number, optionalSort position in the user's template list (default 0).
  • stepUpWeightstrue or false, optionalWhether this workout's weights climb when every working set hit its reps last time. Leave it out for the default — on for a day of the user's program, off for one of their own workouts, because an automatic step would fight a scheme they wrote themselves (5/3/1, waves). Pass true or false to decide it explicitly.
  • clientHandletext, optionalOptional client_handle from list_clients to run this tool against a coached client's data instead of your own. Omit (or pass null) for your own data — the legacy default.