Create a trainee

post

https://api.progress-workout.com/public-api/trainees

Create a new trainee in the company that owns the API key. If no trainerId is supplied, the first trainer in the company is assigned. Pass secondaryTrainerIds to also assign additional trainers alongside the primary one; every id must belong to your company and none may be the primary trainer. The trainee is emailed a welcome message with their login details unless you pass sendWelcomeEmail: false. The companyId is always derived from the API key — any value passed in the body is ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating or updating a trainee via the public API. companyId is always derived from the API key and cannot be passed.

name

string

required

length between 0 and 255

string

required

length between 0 and 255

phoneNumber

string

length between 0 and 64

gender

string

enum

Allowed:

dateOfBirth

string

^(0[1-9]|[12][0-9]|3[01])-(0[1-9]|1[0-2])-\d{4}$

Date of birth in dd-MM-yyyy format (e.g. 02-06-1990).

password

string

required

length between 6 and 255

enabled

boolean

forcePasswordChange

boolean

expirationDate

string

^(0[1-9]|[12][0-9]|3[01])-(0[1-9]|1[0-2])-\d{4}$

Date the trainee's program expires, in dd-MM-yyyy format (e.g. 31-12-2026). Empty or null means no expiration.

trainerId

int64

Optional: trainer id to assign the trainee to. Required at create time when the company has more than one trainer.

secondaryTrainerIds

array of int64s

Optional: ids of additional trainers who also work with this trainee, alongside the primary trainerId. On update this list REPLACES the trainee's current secondary trainers — omit the field to leave them unchanged, or send an empty array to remove them all. Every id must belong to your company, and none may be the primary trainer. Duplicates are ignored.

secondaryTrainerIds

height

double

Trainee height in centimeters.

experienceLevel

string

enum

Allowed:

equipmentType

string

enum

Allowed:

numOfDaysTraining

int32

Number of training days per week.

sendWelcomeEmail

boolean

Defaults to true

Whether to email the new trainee their welcome message with login details. Defaults to true when omitted, matching the behaviour before this flag existed. Set false for bulk imports or migrations that should not email everyone. Create only — ignored on update.

Responses

200Trainee created

400Validation failed or missing required field

401Missing or invalid X-API-Key