Skip to content
Dixa API/
/
List tags

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

Bulk tag conversation

Request

Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/jsonrequired

The list of tags to add to a conversation

dataArray of objects(TagConversationInput)
curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/tags/bulk' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "name": "Example #1"
      },
      {
        "name": "Example #2"
      }
    ]
  }'

Responses

The conversation bulk tag was initiated

Response
No content

List tags

Request

Get the tags 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}/tags' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of tags for a conversation

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

List messages

Request

Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of "_type": "EmailAttributes" if they are created through a webform, or "_type": "ContactFormAttributes" when created through a chat widget.

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

Responses

List of messages for a conversation sorted from oldest to newest

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

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations