v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Messages

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.

post/v2/messages/note

Headers

api-tokenstring required

API Token

Request body

chat_idstring uuid required

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

contentstring required

Text content of the note (1-4096 characters)

authorstring

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

Example request

{
  "chat_id": "550e8400-e29b-41d4-a716-446655440000",
  "content": "AI summary: customer asked about pricing and wants a callback tomorrow.",
  "author": "AI Assistant"
}

Response

Note created

statusinteger

Example response

{
  "status": 201,
  "data": {
    "success": true,
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "chat_id": "550e8400-e29b-41d4-a716-446655440000",
    "content": "AI summary: customer asked about pricing and wants a callback tomorrow.",
    "author": "AI Assistant",
    "type": "NOTE",
    "created_at": "2026-06-15T19:29:13.000Z"
  }
}