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

Path parameters
NameTypeDescription
escortIdrequiredstring
noteIdrequiredstring

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

Minimum length: 1

contentstring

Minimum length: 1

pinnedboolean

true pins the note, false unpins it.

Request examples

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

Example body (application/json)
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "content": "<string>",
    "pinned": true,
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>"
  }
}
Response fields (7)
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

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.