# Update a trainee `PATCH https://api.coach-platform.com/api/public/trainees/{traineeId}` Update a trainee's personal details. Only supplied fields change. - Resource: Trainees - Authentication: API key in the `Authorization: Bearer cp_live_...` header - HTML version: https://www.coach-platform.com/docs/api/reference/patch-trainees-trainee-id - OpenAPI spec: https://www.coach-platform.com/openapi.json ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | `traineeId` | string | Yes | | ## Header parameters | Name | Type | Required | Description | |---|---|---|---| | `Idempotency-Key` | string | No | 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 Content type: `application/json`. Required. | Field | Type | Required | Description | |---|---|---|---| | `name` | string | No | | | `phoneNumber` | string | No | | | `goal` | string | No | | | `height` | number | No | Height in cm. Must not be negative. Minimum: `0`. | | `dateOfBirth` | string | No | Date of birth as an ISO date, for example 1990-04-23. Pattern: `^\d{4}-\d{2}-\d{2}`. | | `gender` | string | No | One of: Male, Female, Other. Matching is case-insensitive, so "male" is accepted and stored as "Male". | | `activityLevel` | string | No | One of: Sedentary, Lightly Active, Moderately Active, Very Active, Extremely Active. Matching is case-insensitive. Feeds the TDEE calculation, so changing it changes the calorie targets derived for this trainee. Weight is NOT set here: it is a dated history, use POST /trainees/{traineeId}/body-metrics. | | `injuries` | string | No | | | `healthConditions` | string | No | | | `allergies` | string | No | | | `foodPreferences` | string | No | | | `foodDislikes` | string | No | | ## Responses | Status | Description | |---|---| | `200` OK | Successful response | | `400` Bad Request | | | `401` Unauthorized | | | `403` Forbidden | | | `404` Not Found | | | `409` Conflict | | | `429` Too Many Requests | | | `500` Internal Server Error | | ### 200 OK Content type: `application/json` | Field | Type | Description | |---|---|---| | `data` | object | | | `data.id` | string | | | `data.name` | string | | | `data.email` | string | | | `data.phoneNumber` | string | | | `data.goal` | string | | | `data.profileImageUrl` | string | | | `data.personalDetails` | object | | | `data.labels` | object[] | | | `data.labels[].id` | string | | | `data.labels[].text` | string | | | `data.labels[].color` | string | | | `data.labels[].coachId` | string | | | `data.assignedEmployees` | object[] | | | `data.assignedEmployees[].id` | string | | | `data.assignedEmployees[].name` | string | | | `data.activeCoachDetails` | object | | | `data.activeCoachDetails.activeEscort` | string \| null | Id of the escort currently in use for this trainee. Fetch the full escort with GET /escorts/{escortId}. | | `data.activeCoachDetails.pendingCoach` | string \| null | Coach id this trainee is pending approval for. Set when the trainee was invited but has not been approved yet; null once approved. Use ?status=pending on GET /trainees to list only these. | | `data.activeCoachDetails.pendingCoachDate` | string \| null | When the trainee entered the pending state. Use it to measure how long approval has been waiting. | | `data.createdAt` | string | | Example: ```json { "data": { "id": "", "name": "", "email": "", "phoneNumber": "", "goal": "", "profileImageUrl": "", "personalDetails": {}, "labels": [ { "id": "", "text": "", "color": "", "coachId": "" } ], "assignedEmployees": [ { "id": "", "name": "" } ], "activeCoachDetails": { "activeEscort": "", "pendingCoach": "", "pendingCoachDate": "" }, "createdAt": "" } } ``` ### Error responses 400, 401, 403, 404, 409, 429, 500 Content type: `application/json` | Field | Type | Description | |---|---|---| | `error` | object | | | `error.code` | string | | | `error.message` | string | | | `error.fix` | string \| null | | | `error.details` | object \| null | | | `error.retryAfterMs` | number \| null | | Example: ```json { "error": { "code": "", "message": "", "fix": "", "details": {}, "retryAfterMs": 123 } } ``` ## Examples ### cURL ```bash curl --request PATCH \ --url 'https://api.coach-platform.com/api/public/trainees/' \ --header 'Authorization: Bearer cp_live_...' \ --header 'Content-Type: application/json' \ --data '{ "name": "" }' ``` ### JavaScript (fetch) ```js const response = await fetch('https://api.coach-platform.com/api/public/trainees/', { method: 'PATCH', headers: { Authorization: 'Bearer cp_live_...', 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "" }), }); const data = await response.json(); ``` ## Related endpoints - [List trainees](https://www.coach-platform.com/docs/api/reference/get-trainees/index.md): `GET /api/public/trainees`. List trainees of the coach, filterable by label/search. - [Create a trainee](https://www.coach-platform.com/docs/api/reference/post-trainees/index.md): `POST /api/public/trainees`. Create a new trainee for the coach. - [Approve or reject pending trainees](https://www.coach-platform.com/docs/api/reference/post-trainees-pending/index.md): `POST /api/public/trainees/pending`. Approve or reject trainees from the coach's approval queue, which GET /trainees?status=pending lists. - [Get a trainee](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id/index.md): `GET /api/public/trainees/{traineeId}`. Get a single trainee by id. - [Remove a trainee](https://www.coach-platform.com/docs/api/reference/delete-trainees-trainee-id/index.md): `DELETE /api/public/trainees/{traineeId}`. Remove a trainee from the coach account. - [Restore an archived trainee](https://www.coach-platform.com/docs/api/reference/post-trainees-trainee-id-restore/index.md): `POST /api/public/trainees/{traineeId}/restore`. Bring a trainee back from the archive, exactly as the dashboard does it. - [Send access details to a trainee](https://www.coach-platform.com/docs/api/reference/post-trainees-trainee-id-send-credentials/index.md): `POST /api/public/trainees/{traineeId}/send-credentials`. Send the trainee their app access details by email, and optionally by WhatsApp. - [Get a trainee's weekly activity](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id-weekly-activity/index.md): `GET /api/public/trainees/{traineeId}/weekly-activity`. Day-by-day activity for the week containing the given date (workouts, cardio, nutrition logging, water, measurements, form submissions). - [Get a trainee's body measurements](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id-measurements/index.md): `GET /api/public/trainees/{traineeId}/measurements`. A trainee's body measurements: weight history, body-fat history, circumference history, and custom measurement types. - [Record a weigh-in](https://www.coach-platform.com/docs/api/reference/post-trainees-trainee-id-body-metrics/index.md): `POST /api/public/trainees/{traineeId}/body-metrics`. Record a weigh-in for a trainee: weight, body fat, and/or body measurements. - [List a trainee's progress photos](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id-photos/index.md): `GET /api/public/trainees/{traineeId}/photos`. A trainee's progress photos as temporary viewable image URLs (valid a few minutes). - [List a trainee's personal records](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id-personal-records/index.md): `GET /api/public/trainees/{traineeId}/personal-records`. A trainee's personal records per exercise: best weight, estimated 1RM, top-set reps, max reps, set and total volume, and max duration, each with the value achieved, the previous record and when it was set. - Previous: [Get a trainee](https://www.coach-platform.com/docs/api/reference/get-trainees-trainee-id/index.md): `GET /api/public/trainees/{traineeId}`. Get a single trainee by id. - Next: [Remove a trainee](https://www.coach-platform.com/docs/api/reference/delete-trainees-trainee-id/index.md): `DELETE /api/public/trainees/{traineeId}`. Remove a trainee from the coach account.