Sign in
Trainees

Record a weigh-in for a trainee: weight, body fat, and/or body measurements. This is the only way to write weight through the API, because weight is kept as a dated history rather than a single field: the previous value is moved into the history and the new one becomes current. PATCH /trainees/{traineeId} therefore does NOT accept weight.

Every field is optional, but send at least one. Send only what was actually measured; omitted fields are left untouched, and each measurement field keeps its own dated history. Measurements are in cm, weight in kg, bodyFat in percent.

post/api/public/trainees/{traineeId}/body-metrics

Path parameters

traineeIdstring required

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

weightnumber

Body weight in kg. Becomes the current weight; the previous one is pushed onto the weight history.

bodyFatnumber

Body fat percentage. Kept as a dated history, exactly like weight.

datestring

ISO date this measurement was taken. Defaults to now. Use it to backfill an earlier weigh-in.

chestnumber

chest in cm.

waistnumber

waist in cm.

rightArmnumber

rightArm in cm.

leftArmnumber

leftArm in cm.

rightThighnumber

rightThigh in cm.

leftThighnumber

leftThigh in cm.

rightCalfnumber

rightCalf in cm.

leftCalfnumber

leftCalf in cm.

necknumber

neck in cm.

buttnumber

butt in cm.

navelnumber

navel in cm.

lowerAbdomennumber

lowerAbdomen in cm.

upperAbdomennumber

upperAbdomen in cm.

upperHipnumber

upperHip in cm.

lowerHipnumber

lowerHip in cm.

Response

Created

Changes

No recorded changes to this endpoint across all 1 revision of this API.