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 […]
Articles Tagged: v3
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 […]
Edit Organization
Edit Organization URL : v3/organisation/update/api/{id} HTTP Method : POST Response Format: JSON Parameters: Parameter Data Type Optional/Required Description organisation_name String Configurable It the name of the organization and it configurable from back end form settings phone String Configurable It the phone no of the organization and it configurable from back end form settings organisation_domain_name[] Array […]
Create Ticket V3
Create ticket as an Agent (Authentication token required) Description: To create a ticket in Faveo from the agent panel. Use this API to create a ticket as an agent on behalf of the customer. HTTP Method : POST URL : v3/newticket/post Content-Type: multipart/form-data NOTE: most of the things mentioned here are configurable by form […]
How to pass OAuth2 token in API version 3
Faveo API version 3 uses OAuth token to grant access to the API endpoints which require user authentication. If you call an API that requires authentication without passing the OAuth token it will return the below response with HTTP status code 422. { “result”: { “fails”: “Unauthorized! Please login again” } } Note: Faveo API […]
Whatsapp Plugin
Adds the Whatsapp Business Account URL : v3/api/whatsapp/create Method : POST Query Parameters : Parameter Type Optional/Required Description name string Required Name of the Account sid string Required SID of the Twilio Account token string Required Auth Token of your Twilio Account business_phone string Required Whatsapp Business Phone Number (Format: +91900120034) Response : { “success”:true, […]
Task Plugin API
Creates the Project URL : v3/tasks/api/project/create Method : POST Query Parameters : Parameter Type Optional/Required Description name string Required Name of the Project Response : { “success”:true, “message”:”Project Created Successfully.” } Fetches all the Projects With Pagination. URL : v3/tasks/api/project/view Method : GET Response : { “success”:true, “data”:[ { “id”:1, “name”:”Sample”, “created_at”:”2020-01-02 09:53:03″, “updated_at”:”2020-01-02 09:53:03″ […]
Attach Asset to Problem
Description: URL: service-desk/api/problem-attach-asset/{problemId} Method: POST Description : Route to attach asset to problem based on problemId and assetId Parameters: Parameter Type Optional/Required Description problem id integer Required Problem id of the problem to attach change asset ids integer Required Asset ids of the assets to be attached to problem is passed through request Success Response : { […]
Attach Ticket to Problem
URL:service-desk/api/problem-attach-ticket/{problemId} Method: POST Description : Route to attach ticket to problem based on problemId and ticketIds Parameters: Parameter Type Optional/Required Description problem id integer Required Problem id of the problem to attach ticket ticket id integer Required Ticket ids of the tickets to be attached to problem is passed through request { “success”:true, “Message”:“Tickets Attached Successfully” }
Update Problem Status to Close
URL: v3/service-desk/api/problem-status-close/{problemId} Method: POST Description : Route to attach change to problem based on problemId and changeId Parameters: Parameter Type Optional/Required Description problem id integer Required Problem id of the problem to update status to close Success Response : { “success”:true, “Message”:“Problem Saved Successfully” }