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. 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.

height

double

Trainee height in centimeters.

experienceLevel

string

enum

Allowed:

equipmentType

string

enum

Allowed:

numOfDaysTraining

int32

Number of training days per week.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Trainee created

400Validation failed or missing required field

401Missing or invalid X-API-Key