Skip to Content
ReferenceAPINotesUpdate a note

Notes API

Update a note

Update a note or its resource links.

PATCH/v1/notes/{noteId}
capability notes.update · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

  • noteIdstring<uuid>required
    path
  • titlestring
    bodymin length 1max length 200
  • contentstring
    bodymax length 100000
  • linksone of 2 shapes[]
    bodymax items 50
    • kind"patient"required
    • resourceIdstring<uuid>required
  • expectedUpdatedAtstring<date-time>required
    body

Response

Successful responses use Dawn's data envelope.

  • dataNoterequired
    • idstring<uuid>required
    • workspaceIdstring<uuid>required
    • titlestringrequired
      min length 1max length 200
    • contentstringrequired
      max length 100000
    • linksone of 2 shapes[]required
      max items 50
      • kind"patient"required
      • resourceIdstring<uuid>required
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • metaobject

Errors

Error responses use the shared error envelope.

  • 403Notes are disabled or a workspace member is required.
  • 404The note could not be found.
  • 422The note or one of its links is invalid.
  • 503The note could not be saved.
Last updated on