Add a private coach note to a coaching period, with an optional…

POST/api/public/escorts/{escortId}/notes

Add a private coach note to a coaching period, with an optional title and pin. Returns the note including its id, which PATCH and DELETE /escorts/{escortId}/notes/{noteId} take. 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.

Path parameters

Path parameters
NameTypeDescription
escortIdrequiredstring

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
titlestring

Short note title, e.g. "Follow-up call".

contentrequiredstring

Note body (plain text). Required.

Minimum length: 1

pinnedboolean

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

Request examples

cURL
curl --request POST \
  --url 'https://api.coach-platform.com/api/public/escorts/<escortId>/notes' \
  --header 'Authorization: Bearer cp_live_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "<string>"
}'
JavaScript (fetch)
const response = await fetch('https://api.coach-platform.com/api/public/escorts/<escortId>/notes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer cp_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "content": "<string>"
  }),
});

const data = await response.json();

Responses

201 Created

Example body (application/json)
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "content": "<string>",
    "pinned": true,
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>"
  },
  "warnings": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}
Response fields (10)
Response fields
NameTypeDescription
dataobject

A private coach note on a coaching period. Never shown to the trainee.

data.idstring
data.titlestring | null
data.contentstring
data.pinnedboolean

true keeps the note at the top of the coaching period notes list.

data.createdAtstring<date-time> | null
data.updatedAtstring<date-time> | null
warningsobject[]

Non-fatal problems with follow-up writes. The resource was created, but each listed field was not applied.

warnings[].fieldstring
warnings[].messagestring

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.