Skip to main content
POST
Create a new contact note

Authorizations

Authorization
string
header
required

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

Body

application/json
contactId
string
required

Contact _id the note is attached to.

note
string

Markdown/plain-text body of the note; may contain @-mention syntax.

mentions
string[]

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

attachments
object[]

R2 storage keys + content metadata for files attached to the note.

Response

Contact note created

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