Replace a Signals note
| Method | Path |
|---|---|
PUT | /v1/signals/notes/:noteId |
Shared authentication, project scope, and response conventions.
An alert note is a practitioner comment stored as a FHIR Communication. It does not edit the alert and is not sent to Signals. Ovok also makes these notes available through /v1/slim/notifications.
The note response has this shape:
| Field | Meaning |
|---|---|
id | Note resource id. |
target.kind, target.id | The target is medical plus an episode id, or alert plus a raw-alert id. |
patientId | Ovok Patient id, or null when unavailable. |
text | Note text. |
author.practitionerId, author.name | Author identity and display name; either may be null. |
createdAt, updatedAt | Timestamps; either may be null. |
Only the author can edit the note, and the caller must be a practitioner with signals_alerts:update.
| Requirement or result | Details |
|---|---|
| Access policy | signals_alerts:update |
| Body | { "text": "..." }; trimmed text must contain 1–2,000 characters. |
| Success | 200 with the updated note. |
403 | Missing capability, caller is not a practitioner, or caller is not the note's author. |
404 | Note does not exist in this project. |
409 | Note changed during the write. Reload it and retry. |
422 | Invalid or too-long text. |
curl --request PUT \
--url 'https://api.sandbox.ovok.com/v1/signals/notes/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{ "text": "Sensor was repositioned at 02:10." }'
Use PUT when your client convention expects full replacement. The API changes only the note text; it does not replace other note fields.