Skip to content

Tags

Ticket Scope

List

Required permission: ticket.agent or admin.tag

GET-Request sent: /api/v1/tags?object=Ticket&o_id={ticket id}

Show response
json
// HTTP-Code 200 OK

{
  "tags": [
    "order",
    "complaint"
  ]
}

Add

Required permission: ticket.agent or admin.tag

POST-Request sent: /api/v1/tags/add

Show request/response
json
{
  "item": "{tag name}",
  "object": "Ticket",
  "o_id": "{ticket id}"
}

INFO

This will create the tag if it doesn't exist and the user has permission to do so.

Remove

Required permission: ticket.agent or admin.tag

DELETE-Request sent: /api/v1/tags/remove

Show request/response
json
{
  "item": "{tag name}",
  "object": "Ticket",
  "o_id": "{ticket id}"
}

Administration Scope

Admin - List

Required permission: admin.tag

GET-Request sent: /api/v1/tag_list

Show response
json
// HTTP-Code 200 OK

[
  {
    "id": 1,
    "name": "order",
    "count": 0
  },
  {
    "id": 2,
    "name": "complaint",
    "count": 0
  },
  {
    "id": 3,
    "name": "printer problem",
    "count": 0
  }
]

Admin - Create

Required permission: admin.tag

POST-Request sent: /api/v1/tag_list

Show request/response
json
{
  "name": "tag 5"
}

Admin - Rename

Required permission: admin.tag

PUT-Request sent: /api/v1/tag_list/{tag id}

Show request/response
json
{
  "name": "order"
}

Admin - Delete

Required permission: admin.tag

DELETE-Request sent: /api/v1/tag_list/{tag id}

Show response

Response:

json
// HTTP-Code 200 OK

{}