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

Header parameters
NameTypeDescription
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

application/json, required

Request body fields
NameTypeDescription
escortIdsrequiredstring[]

Between 1 and 500 escort ids

Minimum items: 1

Maximum items: 500

titlestring

Short note title.

contentrequiredstring

Note body (plain text). Required.

Minimum length: 1

pinnedboolean

true keeps the note at the top of each list. Defaults to false.

Request examples

cURL
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>"
}'
JavaScript (fetch)
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

Example body (application/json)
{
  "data": {
    "updatedEscorts": 123
  }
}
Response fields (2)
Response fields
NameTypeDescription
dataobject
data.updatedEscortsinteger

How many coaching periods received the note.

Error responses

  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict
  • 429 Too Many Requests
  • 500 Internal Server Error

These statuses share the same response body.

Example body (application/json)
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}
Error fields (6)
Error fields
NameTypeDescription
errorobject
error.codestring
error.messagestring
error.fixstring | null
error.detailsobject | null
error.retryAfterMsnumber | null

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.