POST
/
tag
curl --request POST \
  --url https://demo.enneo.ai/api/mind/tag \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "name": "Complaint",
  "fullName": "Second Level: Complaint",
  "parent": 6,
  "reference": "ticket",
  "type": "skill",
  "visibility": "public",
  "color": "grey",
  "properties": {},
  "complexity": "moderate",
  "sla": 8,
  "priority": "do-not-change",
  "channels": [
    "email",
    "chat"
  ],
  "subchannels": [
    2,
    4
  ],
  "detectionDetails": {},
  "assignment": [
    "assignBySubchannel",
    "assignByCustomLogic"
  ],
  "testCase": {},
  "modifiedBy": "John Doe",
  "modifiedAt": "2024-08-29 14:38:12"
}'
{
  "success": true,
  "id": 12345
}

Authorizations

connect.sid
string
cookie
required

Cookie-based authentication

Body

application/json
The new tag that should be created. The only mandatory parameters are name, refernce and type. If the other parameters are not provided, they will revert to defaults.

Tag object

id
integer | null

Internal id, e.g. 123

Example:

123

name
string

e.g. "Complaint"

Example:

"Complaint"

fullName
string

The full name when not shown in a tree

Example:

"Second Level: Complaint"

parent
integer | null

The id of the parent tag. null if on root level. Can be created to create the tree structure of tags

Example:

6

reference
enum<string>

To what this tag can be assigned to

Available options:
ticket,
contract,
customer
Example:

"ticket"

type
enum<string>

Type of the tag

Available options:
skill,
product,
brand,
customerProperty,
contractProperty,
other
Example:

"skill"

visibility
enum<string>
default:public

Visibility of the tag

Available options:
public,
private,
disabled
Example:

"public"

color
enum<string>
default:grey

Color of the tag. Default is grey

Available options:
grey,
green,
red,
blue,
yellow,
purple,
orange,
teal
Example:

"grey"

properties
enum<string>[]

An array of strings that specify special properties. Currently only ['defaultSkill'], if this tag should be assigned if no skill was found

Available options:
defaultSkill
Example:
{}
complexity
string

The complexity of the tag

Example:

"moderate"

sla
number | null

SLA in business hours. So if we have business hours from 9-17h, an 8 hour SLA means ticket has to be solved within one day. NULL means no SLA is assigned.

Example:

8

priority
enum<string>

If set to anything other than do-not-change, then the ticket priority will be set to this value if the tag was assigned (either manually or via AI)

Available options:
do-not-change,
low,
medium,
high
Example:

"do-not-change"

channels
string[] | null

Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels.

Example:
["email", "chat"]
subchannels
number[] | null

Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels.

Example:
[2, 4]
detectionDetails
object

Details how the AI agent is detected

assignment
enum<string>[]
deprecated

Specifies how this tag is being assigned. The details in the assignment are specified in the settings page of the tag. So for example 'assignBySubchannel', 'assignByCustomLogic' means this tag is auto-assigned for certain subchannels, and using a custom logic defined in an executor.

Available options:
assignByChannel,
assignBySubchannel,
assignByTicketProperty,
assignByContractProperty,
assignByCustomerProperty,
assignByCustomLogic,
assignByAI
Example:
["assignBySubchannel", "assignByCustomLogic"]
testCase
object

Test case for the tag

modifiedBy
string

The user that last modified the tag

Example:

"John Doe"

modifiedAt
string

The date and time when the tag was last modified

Example:

"2024-08-29 14:38:12"

Response

200
application/json
Tag added successfully
success
boolean

Indicates if the operation was successful

Example:

true

id
integer

The ID of the added Tag

Example:

12345