Add the same private coach note to up to 500 coaching periods at once
POST/api/public/escorts/notes/bulk
Add the same private coach note to up to 500 coaching periods at once. Every escort must belong to the coach and be reachable by this key, otherwise nothing is written and 403 or 404 is returned. Canceled coaching periods return 422.
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.
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 |
|---|---|---|
escortIdsrequired | string[] | Between 1 and 500 escort ids |
title | string | Short note title. |
contentrequired | string | Note body (plain text). Required. |
pinned | boolean | true keeps the note at the top of each list. Defaults to false. |
Request examples
curl --request POST \
--url 'https://api.coach-platform.com/api/public/escorts/notes/bulk' \
--header 'Authorization: Bearer cp_live_...' \
--header 'Content-Type: application/json' \
--data '{
"escortIds": [
"<string>"
],
"content": "<string>"
}'const response = await fetch('https://api.coach-platform.com/api/public/escorts/notes/bulk', {
method: 'POST',
headers: {
Authorization: 'Bearer cp_live_...',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"escortIds": [
"<string>"
],
"content": "<string>"
}),
});
const data = await response.json();Responses
200 OK
Successful response
{
"data": {
"updatedEscorts": 123
}
}Response fields (2)
| Name | Type | Description |
|---|---|---|
data | object | |
data.updatedEscorts | integer | How many coaching periods received the note. |
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.