Update note

Update an existing note. This is a full update: fields omitted from the body are cleared. The note stays attached to its record; for a person note, set family to move it between the person and their household's family. First retrieve the current note from /api/notes/{id}, apply your changes, then send back the full object. The required permission depends on the note's link type: people and family notes require Write Notes; connection notes require Full Write Connections unless you are the connection's assignee; batches notes require Limited Write Contributions; business notes require Limited Write Contributions or Full Write Accounting; groups notes require group admin access with note permissions (Limited Write Groups); plan and plan_item notes require Full Write Service Plans; reconciliations notes require Full Write Accounting; and workflow_people notes require Full Write Workflows, or being a manager of the workflow or holding an open assignment in it. Any other link type is refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the note

Body Params

The details of the new note

date | null
required

The date of the note as a calendar date (yyyy-MM-dd), with no time component. When omitted on create, the server stores the current date in the tenant's time zone.

string | null
required

The note's text.

string | null

The note's privacy level: limited (only users with access to the note's type), private (only the note's creator) or groups (only current members of specific groups).

type
object | null

The note's type, identified by its code. Values come from the matching note-type property values (e.g. person_note_types, batch_note_types, group_note_types). Defaults to the general type when omitted.

boolean | null

Whether the note's contents are hidden by default and only made visible on demand.

boolean | null

Whether the note is attached to the person's family rather than the person. Only applies to people notes.

groups
array of objects | null

When privacy is groups, the groups whose members can view the note. Only each group's id is used.

groups
int32 | null

The id of the person the note belongs to; required when switching family back to false. Otherwise ignored, as the note stays attached to its current record.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json