Skip to content
/Internal Notes

Add internal notes

Request

Create internal notes in a conversation by providing the conversation id.

Security
ApiKeyAuth(Required scopes: conversation.reply)
Path
conversationIdinteger, (int64)required
Bodyapplication/jsonrequired

The list of internal notes to create for a conversation

dataArray of objects(CreateInternalNoteInput)
POST
/beta/conversations/{conversationId}/notes/bulk
curl -i -X POST \
  'https://dev.dixa.io/beta/conversations/{conversationId}/notes/bulk' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "message": "A sample note",
        "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
        "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
      },
      {
        "message": "Another sample note"
      }
    ]
  }'

Responses

The created internal notes

Bodyapplication/json
dataArray of any(BulkActionOutcome_ErrorResponse_InternalNoteData)
Response
{
  "data": [
    { … },
    { … }
  ]
}