Skip to main content
POST
/
api
/
contact-notes
Create a new contact note
curl --request POST \
  --url https://your-instance.example.com/api/contact-notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "<string>",
  "note": "<string>",
  "mentions": [
    "<string>"
  ],
  "attachments": [
    {
      "key": "<string>",
      "name": "<string>",
      "size": 123,
      "type": "<string>"
    }
  ]
}
'
{}

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
note
string
mentions
string[]
attachments
object[]

Response

Contact note created

Generic response envelope. Endpoint-specific fields are intentionally open.