Dixa
    Nothing Found

Tags

Activate tag

Activate a tag.

SecurityApiKeyAuth
Request
path Parameters
tagId
required
string <uuid>

The tag id

Responses
204

The tag was successfully activated

400

Invalid value for: path parameter tagId, Invalid value extracted from request context

404

An entity in this request could not be found

500

Internal failure during request processing

patch/beta/tags/{tagId}/activate
Request samples 
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Bulk tag conversation
Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created.


SecurityApiKeyAuth 
Request 
path Parameters
conversationId
required
integer <int64> 
 
Request Body schema: application/json
required
The list of tags to add to a conversation


Array of objects (TagConversationInput) 
 
Responses 
202
The conversation bulk tag was initiated


400
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body


404
An entity in this request could not be found


500
Internal failure during request processing


post/beta/conversations/{conversationId}/tags/bulk
Request samples 
application/json
{
  • "data": [
    • {
      • "name": "Example #1"
      },
    • {
      • "name": "Example #2"
      }
    ]
}
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Create tag
Create a tag.


SecurityApiKeyAuth 
Request 
Request Body schema: application/json
required
The tag details


color
string
 
name
required
string
 
Responses 
200
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.


400
Invalid value extracted from request context, Invalid value for: body


500
Internal failure during request processing


post/beta/tags
Request samples 
application/json
{
  • "name": "test",
  • "color": "#000000"
}
Response samples 
application/json
{
  • "data": {
    • "id": "b794a74a-625b-4303-8237-9b11668a9605",
    • "name": "example",
    • "state": "Active"
    }
}
Deactivate tag
Deactivate a tag.


SecurityApiKeyAuth 
Request 
path Parameters
tagId
required
string <uuid> 
The tag id


 
Responses 
204
The tag was successfully deactivated


400
Invalid value for: path parameter tagId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


patch/beta/tags/{tagId}/deactivate
Request samples 
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Get tag
Get a tag by id.


SecurityApiKeyAuth 
Request 
path Parameters
tagId
required
string <uuid> 
 
Responses 
200
The tag


400
Invalid value for: path parameter tagId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/tags/{tagId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "b794a74a-625b-4303-8237-9b11668a9605",
    • "name": "example",
    • "state": "Active"
    }
}
List tags
Get the tags for a particular conversation by providing the conversation id.


SecurityApiKeyAuth 
Request 
path Parameters
conversationId
required
integer <int64> 
 
Responses 
200
List of tags for a conversation


400
Invalid value for: path parameter conversationId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


get/beta/conversations/{conversationId}/tags
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      }
    ]
}
List tags
List all tags in an organization.


SecurityApiKeyAuth 
Responses 
200
The list of tags in an organization


400
Invalid value extracted from request context


500
Internal failure during request processing


get/beta/tags
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      },
    • {
      • "id": "b794a74a-625b-4303-8237-9b11668a9605",
      • "name": "example",
      • "state": "Active"
      }
    ]
}
Tag conversation
Tag a conversation. You may only use active tags to tag conversations.


SecurityApiKeyAuth 
Request 
path Parameters
conversationId
required
integer <int64> 
 
tagId
required
string <uuid> 
 
Responses 
204
The conversation was successfully tagged


400
Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


put/beta/conversations/{conversationId}/tags/{tagId}
Request samples 
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Untag conversation
Untag a conversation. You may remove active or inactive tags from a conversation.


SecurityApiKeyAuth 
Request 
path Parameters
conversationId
required
integer <int64> 
 
tagId
required
string <uuid> 
 
Responses 
204
The conversation was successfully untagged


400
Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context


404
An entity in this request could not be found


500
Internal failure during request processing


delete/beta/conversations/{conversationId}/tags/{tagId}
Request samples 
Response samples 
application/json
{
  • "message": "Invalid value in request"
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2024