This v1 API had been deprecated from 15th March 2020 and we do not recommend using it. This API will be converted to v3 for public use.
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 Method : GET
- URL Request Example:
Response
- Response Format: JSON
- Returns JSON which contains the result.
Sample JSON Success Response :
{
"result": "success"
}
Response Description:
| Parameter | Description |
| result | It will return success for positive response else it will return fails. |
Possible Errors/Failures:
{
"error": {
"url": [
"The url format is invalid."
]
}
}
OR
{
“result”:”Invalid url”
}
OR
{
"error": {
"url": [
"The url field is required."
]
} }
OR