Edit a note's text

Method	Path
PATCH	/v1/slim/notifications/notes/:noteId

Authentication · Access policies

Changes a note's text. A note is a practitioner's comment on a notification, stored as a FHIR Communication whose basedOn points at the alert. The alert itself is never changed.

Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Patient:read (admins and super admins skip this check). Only the note's author can change it. Scope: The caller's project (from the token). An alert or note from another project, of another kind, or that does not exist answers the same 404.

Behaviour

• Same effect as PUT: a note's text is the only field a caller can change.
• text is trimmed and must be 1 to 2000 characters.
• If the note changed while your edit was in flight, the route answers 409. Reload the note and try again.

Example

curl -X PATCH 'https://api.sandbox.ovok.com/v1/slim/notifications/notes/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
  -H "Authorization: Bearer ${OVOK_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d '{ "text": "Resident was in the bathroom; back in bed 02:14." }'

Successful response

200 — The note as stored.

Errors

Status	Meaning
401	Bearer token is missing, invalid or expired.
403	You lack Patient:read or are not the note's author.
404	The notification or note does not exist, or belongs to another project or another kind.
409	The note changed while this edit was in flight. Reload it and try again.
422	text is empty or over 2000 characters.