Create note

Attach a note to a record. link and entity identify the record the note belongs to (e.g. a person, group, batch, connection or bank reconciliation), type and privacy are codes. Returns the new note's id. The required permission depends on the note's link type: people and family notes require Write Notes; connection notes require Full Write Connections; batches notes require Limited Write Contributions; business notes require Limited Write Contributions or Full Write Accounting; and groups notes require group admin access with note permissions (Limited Write Groups).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the note

date-time | null
required

The date of the note.

int32 | null
required

The id of the record the note is attached to, within the context of link (e.g. the person, group, batch, connection or bank reconciliation id). For family notes, the family id. On update the note stays attached to this record and cannot be re-pointed; for a person note it identifies the person used by the family toggle.

string | null
required
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
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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