API DocsAPI Docs / POST /api/v1/training/workout-plans

POST /api/v1/training/workout-plans

Create a new workout plan for yourself or a trainee: empty, or as a copy of a built-in workout plan template.

Permissions

Request Body Parameters

Note: setting is_active to true deactivates the owner's other plans; the trainee's when trainee_id is sent, your own otherwise. A trainer's own plans are never touched by a plan created for a trainee.

Creating from a template

With workout_plan_template_id, the template's sessions, exercises, set structure (technique and parameters, rep ranges, tempo, rest) and exercise groups are copied into the new plan in one transaction. Text (plan, session and exercise notes) is copied in the request locale (Accept-Language: fa or en). The copy is fully independent: it can be edited or deleted like any plan, and later changes to the template never reach it. Ownership, trainee_id, is_active and the trainee's "new workout plan" notification behave exactly as for an empty plan. Templates are free (workout_plans.create only).

The response then also includes every session's exercises (Workout Plan Exercise Resource, with exercise and group loaded): see the session resource. Without a template the response shape is unchanged.

Response

201 Created

{ /* workout plan resource */ }

• Workout Plan Resource

Error Responses