Skip to content
Dixa API/
/
Tag conversation

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

List flows

Request

List all conversations flows in an organization.

Security
ApiKeyAuth
Query
channelstring

An optional ConversationChannel can be specified to filter the flows. If not provided, the default channel is PstnPhone. Possible values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Email, ContactForm, Callback, PstnPhone, Messenger]

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/flows?channel=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of conversation flows

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

Tag conversation

Request

Tag a conversation. You may only use active tags to tag conversations.

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

Responses

The conversation was successfully tagged

Response
No content

Untag conversation

Request

Untag a conversation. You may remove active or inactive tags from a conversation.

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

Responses

The conversation was successfully untagged

Response
No content

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