Create chat note

Create an internal note (annotation) on a conversation. The note appears in the conversation history identically to a note created in the UI, scoped to the authenticated owner. Internal notes are never sent to the contact. Note: @mentions in the content are stored verbatim but do not trigger mention notifications.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

UUID of the conversation (chat) to add the note to

string
required
length ≤ 4096

Text content of the note (1-4096 characters)

string
length ≤ 120

Optional display name shown as the note author in the conversation history. Defaults to "API" when omitted.

Headers
string
required

API Token

Responses

401

Authentication error - invalid or missing api-token

403

The attendance API feature is not enabled for your account

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json