Skip to main content
POST
Add a note to a contact

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of one of the member's contacts.

Body

application/json

A new note about the contact named by the path.

body
string
required

Note text.

Required string length: 1 - 10000
Pattern: \S
pinned
boolean

Whether it is pinned; false unless set.

Response

The new note.

One note.

status
integer
required
data
object
required

A note on one of the member's contacts.

meta
object
required

Envelope metadata present on every response.