URL: v3/api/tag/

Method: POST

Query Parameters

Parameter Type Possible Values Required/Optional Description
visible_to array  all_users, agents,   logged_in_users   logged_in_users_and_agents Required This field provides access, who can see the tags. Multiple user visibility can be selected from drop down.

Response :

{
    "success": true,
    "message": "Tag saved successfully"
}


URL: v3/api/tag/update/7

Method: PATCH

Query Parameters

Parameter Type Possible Values Required/Optional Description
visible_to array  all_users, agents,   logged_in_users   logged_in_users_and_agents Required This field provides access, who can see the tags. Multiple user visibility can be selected from drop down.

Response :

{
    "success": true,
    "message": "Tag updated successfully"
}

 

URL: v3/api/tags-list/

Method: GET

Query Parameters: Above parameter mentioned in POST method is used.

Response:

{
    "success": true,
    "data": { 
        "current_page": 1,
        "first_page_url": "http://test.com/faveo-helpdesk/public/v3/api/tags-list?page=1", 
        "from": 1, 
        "last_page": 1, 
        "last_page_url": "http://test.com/faveo-helpdesk/public/v3/api/tags-list?page=1",
        "next_page_url": "http://test.com/faveo-helpdesk/public/v3/api/tags-list?page=1",
        "path": "http://test.com/faveo-helpdesk/public/v3/api/tags-list",
        "per_page": 10,
        "prev_page_url": null,
        "to": 10,
        "total": 2,
        "tags": [
           {
              "id": 3,
              "name": "Filder",
              "description": "Top filders description",
              "visible_to": "all_users",
              "ticket_count": 1
           },
           {
              "id": 5,
              "name": "City",
              "description": "<p>description regarding city</p>\r\n",
              "visible_to": "all_users,logged_in_users_and_agents,agents",
              "ticket_count": 0
           },
       ]
    }
}