NOTE: User must be logged in as admin to access this API URL: api/location/delete/{locationId} Method: DELETE Description: Delete a Location. Parameters: Parameter Type Optional/Required Description location Integer Required Location id of the Location to be deleted. Success Response : { “success”: true, “message”:”Location deletion request has been processed successfully. Location will be deleted shortly after […]
Category: Helpdesk
Update Label
NOTE: User must be logged in as admin to access this API URL : v3/api/label-update/{labelId} Method: PATCH Query Parameters : Parameter Type Required/Optional Description title String Required Label Name color String Required Color of the label order Integer Required Order of Label status boolean Optional Status Of Label Response: { “success”: true, “message”: “Label updated Successfully” […]
Knowledge base API’s
1. Search URL: v3/api/search Method: get Response Format: JSON Description: Searches for articles in the knowledge base Parameters: Name Data Type Required / Optional Description s String Required The string that user wants to search token String Optional If the token is provided, backend considers that as logged in user, else guest Success Response: […]
URL
Description: This API is used to check the base URL(where Faveo is installed) is valid or not. URL : api/v1/helpdesk/url (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description url String Required Url of the website api_key String optional Api key HTTP […]
Installer API
Description: This API is used to install Faveo Helpdesk desktop edition Category:- This API has two categories To config database URL : api/v1/database-config To complete installation URL : api/v1/system-config Parameters : Name Data Type Required/Optional Description default String Required Faveo makes a […]
Ticket Table Structure
Tickets Column Type Null Default Links to Comments id (Primary) int(10) No ticket_number varchar(255) No user_id int(11) No dept_id int(11) No team_id int(11) No priority_id int(11) No sla int(11) No help_topic_id int(11) No status int(11) No flags int(11) No ip_address int(11) No assigned_to int(11) No lock_by int(11) No lock_at int(11) No source int(11) No isoverdue […]
Billing API
Description: Checking billing access to the URL. API checks if the customer has purchased the pro app URL: v3/api/check-url (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description api_key String Optional An alphanumeric code that can be used to authenticate your API calls url String […]
FCM API
Description: Sends the FCM token to the app server. This API enables push notification feature. URL: api/v3/helpdesk/fcmtoken (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description id Integer Required Id of the user os string Optional OS type fcm_token string Required Token of the device […]