Edit a coach note on a coaching period
PATCH/api/public/escorts/{escortId}/notes/{noteId}
Edit a coach note on a coaching period. Only supplied fields change. Take noteId from GET /escorts/{escortId}/notes.
Authentication
Requires an API key, sent as Authorization: Bearer cp_live_....
API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.
Path parameters
| Name | Type | Description |
|---|---|---|
escortIdrequired | string | |
noteIdrequired | string |
Header parameters
| Name | Type | Description |
|---|---|---|
Idempotency-Key | string | 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
application/json, required
| Name | Type | Description |
|---|---|---|
title | string | |
content | string | |
pinned | boolean | true pins the note, false unpins it. |
Request examples
curl --request PATCH \
--url 'https://api.coach-platform.com/api/public/escorts/<escortId>/notes/<noteId>' \
--header 'Authorization: Bearer cp_live_...' \
--header 'Content-Type: application/json' \
--data '{
"title": "<string>"
}'const response = await fetch('https://api.coach-platform.com/api/public/escorts/<escortId>/notes/<noteId>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer cp_live_...',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"title": "<string>"
}),
});
const data = await response.json();Responses
200 OK
Successful response
{
"data": {
"id": "<string>",
"title": "<string>",
"content": "<string>",
"pinned": true,
"createdAt": "<date-time>",
"updatedAt": "<date-time>"
}
}Response fields (7)
| Name | Type | Description |
|---|---|---|
data | object | A private coach note on a coaching period. Never shown to the trainee. |
data.id | string | |
data.title | string | null | |
data.content | string | |
data.pinned | boolean | true keeps the note at the top of the coaching period notes list. |
data.createdAt | string<date-time> | null | |
data.updatedAt | string<date-time> | null |
Error responses
400Bad Request401Unauthorized403Forbidden404Not Found409Conflict429Too Many Requests500Internal Server Error
These statuses share the same response body.
{
"error": {
"code": "<string>",
"message": "<string>",
"fix": "<string>",
"details": {},
"retryAfterMs": 123
}
}Error fields (6)
| Name | Type | Description |
|---|---|---|
error | object | |
error.code | string | |
error.message | string | |
error.fix | string | null | |
error.details | object | null | |
error.retryAfterMs | number | null |
More Escorts endpoints
This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.