Skip to main content
POST
Add an internal note

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Body

application/json
body
string
required

Note text. Maximum 4000 characters.

Maximum string length: 4000
Example:

"VIP customer — fast-track any shipping issues."

conversationId
string

ID of a conversation whose contact the note is attached to. Provide this or phone, not both. List conversations with GET /api/v1/conversations.

Example:

"cmbxgz9pq0003ph01m4n5o6p7"

phone
string

WhatsApp phone number of the contact, in international format. Provide this or conversationId, not both. Resolves to the contact's most recently active WhatsApp conversation.

Required string length: 3 - 32
Example:

"+971500000000"

Response

Note added

note
object