Inbox notes

Adds an internal note to a conversation

post

Required Permission: chatbots.inbox.notes.send

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

Body

application/json

conversationIdstringRequired

The ID of the conversation to which the note is added.

Example: VWQB39R64JQQM9rMkqtK

textstringRequired

The text content of the note.

Example: Customer asked for a discount.

mentionsstring[]Optional

A list of agent IDs mentioned in the note.

Example: ["wiDCerXfAVj0I1t5FbjR"]

Responses

201

Note successfully created as a message.

application/json

400

Invalid input data.

403

Insufficient permissions.

post

/v1/inbox/{chatbotId}/notes

HTTPcURLJavaScriptPython

POST /v1/inbox/{chatbotId}/notes HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "conversationId": "VWQB39R64JQQM9rMkqtK",
  "text": "Customer asked for a discount.",
  "mentions": [
    "wiDCerXfAVj0I1t5FbjR"
  ]
}

{
  "message": {
    "id": "msg_abc123xyz",
    "sender": "bot",
    "type": "text",
    "persona": {
      "image": "https://storage.example.com/avatars/support.png",
      "name": "Support Bot"
    },
    "providerMessageId": "wamid.HBgNNDkxNTEyNjAyNTQ1Ng==",
    "status": "delivered",
    "created": "2025-10-06T12:00:00Z",
    "processed": "2025-10-06T12:00:01Z",
    "sent": "2025-10-06T12:00:02Z",
    "received": "2025-10-06T12:00:03Z",
    "read": "2025-10-06T12:00:10Z",
    "outgoing": true,
    "messengerId": "messenger_abc123",
    "contextId": "ctx_xyz789",
    "content": {
      "text": "text",
      "file": {
        "name": "text",
        "url": "text",
        "type": "text",
        "mimeType": "text",
        "size": 1,
        "attachmentRef": "text",
        "caption": "text",
        "transcript": "text"
      },
      "buttons": {
        "buttons": [
          {
            "label": "text",
            "type": "text",
            "value": "text",
            "payload": "text"
          }
        ]
      },
      "selectedButton": {
        "label": "text",
        "value": "text",
        "payload": "text",
        "type": "text",
        "reference": "text"
      },
      "template": {
        "body": "text",
        "header": "text",
        "footer": "text"
      },
      "contact": {
        "addresses": [
          {
            "city": "text",
            "country": "text",
            "countryCode": "text",
            "street": "text",
            "type": "text",
            "zip": "text"
          }
        ],
        "emails": [
          {
            "email": "[e-mail]",
            "type": "text"
          }
        ],
        "name": {
          "firstName": "text",
          "formattedName": "text",
          "lastName": "text"
        },
        "org": {
          "company": "text",
          "title": "text"
        },
        "phones": [
          {
            "phone": "text",
            "type": "text",
            "waId": "text"
          }
        ]
      },
      "location": {
        "latitude": 1,
        "longitude": 1
      },
      "note": {
        "text": "text",
        "mentions": [
          "text"
        ]
      },
      "voiceHangup": {
        "reason": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "voiceTransfer": {
        "target": "text",
        "reason": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "agentHandover": {
        "reason": "text",
        "timeoutSeconds": 1,
        "agentId": "text",
        "groupId": "text",
        "assignmentMethod": "text"
      },
      "email": {
        "subject": "text",
        "body": "text",
        "from": "text",
        "to": [
          "text"
        ],
        "cc": [
          "text"
        ],
        "bcc": [
          "text"
        ],
        "attachmentIds": [
          "text"
        ],
        "references": [
          "text"
        ]
      },
      "transcription": {
        "text": "text",
        "language": "text",
        "audioRef": "text"
      },
      "textToSpeech": {
        "text": "text",
        "speech": "text"
      },
      "reaction": {
        "reactionToMid": "text",
        "action": "text",
        "reaction": "text",
        "emoji": "text"
      },
      "callSettings": {
        "userInputSpeechDetectionTimeout": 1,
        "dtmf": true,
        "bargeIn": true
      },
      "metaWhatsappTemplate": {
        "templateName": "order_shipped_notification",
        "language": "DE",
        "bodyText": "Your order {{1}} has been shipped.",
        "headerText": "text",
        "footerText": "text",
        "header": {
          "file": {
            "name": "header_image.png",
            "url": "https://storage.example.com/files/header.png",
            "type": "image",
            "mimeType": "image/png",
            "size": 51200,
            "attachmentRef": "att_header123"
          },
          "parameters": [
            "Order #12345"
          ]
        },
        "bodyParameters": [
          "#12345"
        ],
        "buttons": [
          {
            "label": "Track Order",
            "type": "URL",
            "url": "https://example.com/track/{{1}}",
            "value": "track_order"
          }
        ]
      },
      "operator": {
        "operatorId": "op_abc123xyz"
      },
      "delay": 1,
      "leadAiId": "text"
    },
    "tags": [
      "important",
      "follow-up"
    ],
    "error": "text",
    "isSensitive": false,
    "streamGroupId": "stream_abc123",
    "delay": 1000
  },
  "error": "text"
}