Trainees

Remove a trainee from the coach account. This ends the active escort, cancels their upcoming meetings, unlinks their training plan and nutrition menu and deletes their gamification profile.

The trainee is archived rather than erased: their account, history and measurements are kept, they stop counting against your trainee limit, and they disappear from GET /trainees and from GET /trainees/{traineeId}, which answers 403 for them afterwards. List archived trainees with GET /trainees?status=archived and bring one back with POST /trainees/{traineeId}/restore.

delete/api/public/trainees/{traineeId}

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.

Response

Successful response

Changes

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