Skip to main content
PATCH
Update a contact note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

noteId
string
required

Body

application/json
note
string

Replacement body for the note; flips isEdited to true on save.

mentions
string[]

User _ids @-mentioned in the note; trigger notification pings.

attachments
object[]

R2 storage keys + content metadata for files attached to the note; replaces the existing attachment list.

Response

Contact note updated

success
enum<boolean>
required
Available options:
true
data
object
required

Populated note row. userId is populated to the user document (see ContactNoteAuthor).

Example:
message
string