URL : v3/api/delete-form-data Method : DELETE Query Parameters : Parameter Type Optional/Required Description id integer Required Id of the field that is required to be deleted type string Required Whether field or option Possible values are “option” ,”label” and “field” Response : { “success”:true, “Message”:”Successfully deleted” }
Articles Tagged: v3
Add Collaborators
URL : v3/api/ticket/collaborators Method : POST Query Parameters : Parameter Type Optional/Required Description ticket-id integer Required Ticket id of current ticket collaborator-ids Array Required Array of collaborator ids Response : { “success”:true, “message”:”Successfully added” }
Create User and add him/her as Collaborator
URL : v3/api/ticket/create-add-collaborator Method : POST Query Parameters : Parameter Type Optional/Required Description ticket-id integer Required Ticket id of current ticket name string Required Name of the collaborator email string Required Email of the collaborator Response : { “success”:true, “message”:”Successfully added” }
Tickets-List
Ticket List NOTE: User must me logged in as agent or admin to access this API URL : v3/api/agent/ticket-list Method : GET Query Parameters : Parameter Type Possible Values Required/Optional Description category String all, inbox, mytickets, closed, unassigned, followup, deleted, unapproved Required ‘all’ can be used to get all the tickets irrespective of which category […]
Merge-Ticket-List
NOTE: User must me logged in as agent or admin to access this API URL : v3/api/agent/tickets/get-merge-tickets Method : GET Query parameters: NOTE : At most one of the two parameters must be passed Parameter Type Optional/Required Description ticket-id Integer Optional Ticket-id of a single ticket. In this case backend returns for all the tickets […]
Dependency-List
URL : v3/api/dependency/{type} Description : Type can be any of the following help-topics priorities organizations users user-types types sources statuses sla-plans agents teams agents-teams(for getting both agents as well as teams) labels tags departments languages rating-types country-codes locations client-tickets(for getting client tickets) ticket-status-tabs (for getting client tickets status details) Method : GET Query Parameters: […]
Ticket-Suggestions by subject and ticket number
URL : v3/api/agent/ticket-suggestions Method : GET Query Parameters: Parameter Type Optional/Required Possible values Description category string Optional all, inbox, mytickets, closed, unassigned, followup, deleted, unapproved ‘all’ can be used to get all the tickets irrespective of which category they belongs. Rest of the category will give only tickets from that category. By default it gives […]
Ticket-details
URl : v3/api/agent/ticket-details/{ticketId} Method : GET Query Parameters : None Response : { “success”: true, “data”: { “ticket”: { “id”: 10394, “ticket_number”: “AAA-TICKET-NUMBER”, “isoverdue”: “0”, “isanswered”: “0”, “status”: { “id”: 1, “name”: “Open” }, “type”: { “id”: 1, “name”: “Question” }, […]
Ticket-threads
URL : v3/api/agent/ticket-threads/{ticketId} Method : GET Query Parameters : Parameter Type Optional/Required Description page integer Optional To get any page’s data. If not passed then current page will be 1. limit integer Optional Number of records that is needed to be fetched from DB. If it is not passed, first 10 records will be returned. […]
Ticket Filters List
URL: v3/api/agent/ticket-filter Method : GET Parameters: none Response: { “success”: true, “data”:{ “own”: [{ “id”: 50, “name”: “First filter” }], “shared”: [{ “id”: 51, “name”: “Second filter” }] } }