Faveo – Page 5 – Faveo Developers Documentation

Advance Search On Knowledge Base Articles

URL: v3/api/search Method: GET Query Parameters Parameter Type Possible Values Required/Optional Description name integer 0,1 Optional If this field is checked then whatever someone is searching should be present in article name. description integer 0,1 Optional If this field is checked then whatever someone is searching should be present in article description. case_sensitive integer […]

Update Label

URL: v3/api/label Method: POST Query Parameters Parameter Type Possible Values Required/Optional Description visible_to array agents, team_lead, dept_mngr Required This field provides access, who can see the tags. Multiple user visibility can be selected from drop down. Response : { “success”: true, “message”: “Label saved successfully” } URL: v3/api/label-update/7 Method: PATCH Query Parameters Parameter Type Possible Values Required/Optional Description visible_to array […]

Update Tag

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 […]

Custom CSS Plugin

URL: custom-css/create Method: GET Note – Hit this URL to open the view page for creating the custom css. URL: custom-css/create Method: POST Query Parameters: Parameter Type Possible Values Required/Optional Description name string string Required This field is unique. fired_at string adminlayout, agentlayout, clientlayout Required This field indicates where custom css should be applied. script string […]

Get CRON Scheduler Data

NOTE: User must me logged in as admin to access this API URL : v3/api/admin/get-cron-setting Method : GET Success Response: { “success”: true, “data”: { “cron_path”: “/var/www/faveo/artisan”, “job_list”: [ { “id”: 1, “job”: “fetching”, “value”: “dailyAt,12:12”, “created_at”: “2021-03-17 06:05:37”, “updated_at”: “2021-03-22 13:06:06”, “icon”: “fas fa-mail-bulk”, “command”: “ticket:fetch”, “job_info”: “fetching-info”, “active”: 1, “plugin_job”: 0, “plugin_name”: null […]

Update Cron Scheduler Data

NOTE: User must me logged in as admin to access this API URL : v3/api/admin/update-cron-setting Method : PATCH Query Parameters : Note: Parameters need to be passed in job_list array job_name array with active, value and time*(only if value=dailyAt) parameters Parameter Type Possible Values Required/Optional Description active Boolean 1 or 0 Optional Active value could […]

Update System Default Language

NOTE: User must me logged in as admin to access this API URL : v3/api/admin/update-system-language/{languageIso} Method : PATCH Success Response: { “success”:true, “message”:”Default Language Updated Successfully” }

Get Language List

NOTE: User must be logged in as admin to access this API URL : v3/api/admin/language-list Method : GET Query Parameters : Parameter Type Possible Values Required/Optional Description sort-field String language, native_name, iso_code Optional Field name to sort sort-order String asc, desc Optional Sorting order either ascending or descending search-query String Optional Keyword to be searched […]