Skip to content
Dixa API/
/
Get tag

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

Ratings

Operations

Tags

Operations

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

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 tags

Request

List all tags in an organization. Only active tags are returned by default. To include deactivated tags use ?includeDeactivated=true.

Security
ApiKeyAuth
Query
includeDeactivatedboolean

Whether to include deactivated tags in the response. If not provided, only active tags are listed.

Default false
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/tags?includeDeactivated=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of all tags in an organization

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

Create tag

Request

Create a tag.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

The tag details

namestringrequired
colorstring
curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/tags \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "test",
    "color": "#000000"
  }'

Responses

The created tag or an existing tag with the same name. Note that the tag is not updated to match the input in case it already exists.

Bodyapplication/json
dataobject(Tag)required
data.​idstring(uuid)required
data.​namestringrequired
data.​colorstring
data.​statestringrequired

values: [Active, Inactive]

Response
application/json
{
  "data": {
    "id": "b794a74a-625b-4303-8237-9b11668a9605",
    "name": "example",
    "state": "Active"
  }
}

Get tag

Request

Get a tag by id.

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

Responses

The tag

Bodyapplication/json
dataobject(Tag)required
data.​idstring(uuid)required
data.​namestringrequired
data.​colorstring
data.​statestringrequired

values: [Active, Inactive]

Response
application/json
{
  "data": {
    "id": "b794a74a-625b-4303-8237-9b11668a9605",
    "name": "example",
    "state": "Active"
  }
}

Delete tag

Request

Deletes the tag and all its associations. Note that this operation is irreversible.

Security
ApiKeyAuth
Path
tagIdstring(uuid)required

The tag id

curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/tags/{tagId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The tag was successfully deleted

Response
No content

Deactivate tag

Request

Deactivate a tag.

Security
ApiKeyAuth
Path
tagIdstring(uuid)required

The tag id

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/tags/{tagId}/deactivate' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The tag was successfully deactivated

Response
No content

Activate tag

Request

Activate a tag.

Security
ApiKeyAuth
Path
tagIdstring(uuid)required

The tag id

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/tags/{tagId}/activate' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The tag was successfully activated

Response
No content

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations