Tags¶

Ticket scope¶

List¶

Required permission: ticket.agent or admin.tag

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

Sample response:

# HTTP-Code 200 OK

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

Search¶

Required permission: ticket.agent or admin.tag

GET-Request sent: /api/v1/tag_search?term={tag name}

Hint

Zammad will return all tags that contain your search phrase.

Sample response:

# HTTP-Code 200 OK

[
    {
        "id": 1,
        "value": "americano"
    },
    {
        "id": 2,
        "value": "complaint"
    },
    {
        "id": 3,
        "value": "viennese melange"
    }
]

Add¶

Required permission: ticket.agent or admin.tag

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

{
    "item": "{tag name}",
    "object": "Ticket",
    "o_id": {ticket id}
}

Hint

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

Response:

# HTTP-Code 201 Created

true

Remove¶

Required permission: ticket.agent or admin.tag

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

{
    "item": "{tag name}",
    "object": "Ticket",
    "o_id": "{ticket id}"
}

Response:

# HTTP-Code 201 Created

true

Administration scope¶

Admin - List¶

Required permission: admin.tag

GET-Request sent: /api/v1/tag_list

Sample response:

# HTTP-Code 200 OK

[
    {
        "id": 1,
        "name": "americano",
        "count": 0
    },
    {
        "id": 2,
        "name": "complaint",
        "count": 0
    },
    {
        "id": 3,
        "name": "viennese melange",
        "count": 0
    }
]

Admin - Create¶

Required permission: admin.tag

POST-Request sent: /api/v1/tag_list

{
  "name": "tag 5"
}

Response:

# HTTP-Code 200 OK

{}

Admin - Rename¶

Required permission: admin.tag

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

{
  "name": "order"
}

Response:

# HTTP-Code 200 OK

{}

Admin - Delete¶

Required permission: admin.tag

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

Response:

# HTTP-Code 200 OK

{}