Skip to content
Dixa API/
/
Add internal notes

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Add internal notes

Request

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

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The list of internal notes to create for a conversation

dataArray of objects(CreateInternalNoteInput)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/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 BulkActionFailure_ErrorResponse_InternalNoteData (object) or BulkActionSuccess_ErrorResponse_InternalNoteData (object)(BulkActionOutcome_ErrorResponse_InternalNoteData)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

List internal notes

Request

Get all internal notes for a particular conversation by providing the conversation id.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/notes' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of internal notes for a conversation sorted from oldest to newest

Bodyapplication/json
dataArray of objects(InternalNoteData)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Add internal note

Request

Create an internal note in a conversation by providing the conversation id.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The internal note to create for a conversation

messagestringrequired
agentIdstring(uuid)
createdAtstring(date-time)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/notes' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "message": "A sample note",
    "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
  }'

Responses

The created internal note

Bodyapplication/json
dataobject(InternalNoteData)required
data.​idstring(uuid)required
data.​authorIdstring(uuid)required
data.​createdAtstring(date-time)required
data.​csidinteger(int64)required
data.​messagestringrequired
Response
application/json
{
  "data": {
    "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
    "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
    "csid": 9456,
    "message": "A sample note"
  }
}

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations