1. Deactivate User Api URL: v3/api/account/deactivate/{userId} Method: POST Response Format: JSON Parameters : Name Data Type Required / Optional Description action_on_assigned_tickets string Required surrender action_on_owned_tickets string Required takes two values => 1. close => if you want to close the tickets of the user.2. change_owner => If you want to change the owner of the tickets of this user. […]
Category: Helpdesk
Admin Panel
Admin Settings
Agent Dashboard
Agent Panel
Approval Workflow
Client Panel
System Logs
Ticket Actions
Ticket Info
Time Track
Assign Ticket
Description: Api to assign ticket to an agent or admin HTTP Method : PATCH URL : v3/ticket/assign Content-Type: application/json Name Data Type Required / Optional Description assigned_to string Required takes two values => 1. user_{user_id} => if you want to assign to an agent or yourself, in this case replace user id with the […]
Location List
NOTE: User must be logged in as admin to access this API URL : api/location-list Method: GET Query Parameters : Parameter Type Possible Values Required/Optional Description sort-field String name Optional Field name to sort sort-order String asc, desc Optional Sorting order either ascending or descending search-query String location name Optional Keyword to be searched in Location […]
Create Label
NOTE: User must be logged in as admin to access this API URL : v3/api/label Method : POST Query Parameters : Parameter Type Possible Values Required/Optional Description title String Label One Required Label Name color String #000000 Required Color of the label order Integer 1 Required Order of Label Response: { “success”: true, “message”:”Label Saved Successfully” }
Handling widgets
Faveo widgets allow admin to add social media icons and custom footer widgets in the client panel. The APIs are exclusively accessible by Admin users. Both social media icons and footer widgets can be accessed via the same API by just passing type slug to inform the system which widget record we want to access. Get widget […]
Sla CRUD
Get SLA URL : v3/api/get-enforcer/sla/{slaId} Method : GET Response : { “success”: true, “data”: { “sla”: { “id”: 84, “name”: “Test Sla”, “status”: 1, “order”: 1, “matcher”: “all”, “is_default”: 0, “internal_notes”: “”, “created_at”: “2019-12-09 11:12:15”, “updated_at”: “2019-12-09 11:12:15”, “sla_meta”: [{ “id”: 14, “ticket_sla_id”: 14, “priority_id”: 1, “respond_within”: “diff::1~hour”, “resolve_within”: “diff::1~hour”, “business_hour_id”: 1, “send_email_notification”: 1, “send_app_notification”: […]
Form Group
URL : v3/api/post-form-group Method : POST Query Parameters : None Body Parameters : Parameter Type Possible values Optional/Required Description name string Required Name of the form group form-fields array Array of objects Required Form fields which are updated or newly created. Please read below for detailed explanation help_topic_ids array Optional array of help topic […]
Login
Description: Authenticates a user and gives his/her profile information back if successful. URL: v3/api/login Method: POST Response Format: JSON Parameters : Name Data Type Required / Optional Description user_name String Required Username of the Agent password String Required Password of the Agent Success Response : { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGkvbG9naW4iLCJpYXQiOjE1MTg2MDI1NTAsImV4cCI6MTUxODYwMjc5MCwibmJmIjoxNTE4NjAyNTUwLCJqdGkiOiJpTjFMSkl5M0U2UXB5aUpaIn0.QrXxRYlowT4v2BayTNvapnHUe1vMJ_NlXydgJoS7y1E”, “user”: […]
Refresh Token
URL: v3/api/refresh Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required Old token Success Response { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGt3uPtvQARsvo” } }
Logout
URL: v3/api/logout Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required token Success Response { “success”: true, “message”: “Successfully logged out” }