Errors

Treevox uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Treevox's servers (these are rare).

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

Object error

JSON

{
    "timestamp": "2021-11-18T14:54:56.626Z",
    "message": "Validation failed",
    "code": "bad_request",
    "errors": [
        {
            "property": "name_property",
            "validator": {
                "isNumber": "limit must be a number"
            }
        }
    ]
}

Name	Required	Type	Description
timestamp		String	Error date
message		String	A human-readable message providing more details about the error.
code		String	For some errors that could be handled programmatically, a short string indicating the error code reported.
errors		Array<Object>	Detailed description of the request errors. This field may be empty. When code is bad_request, errors contains the list of errors
errors[].property		String	Property that is generating the error
errors[].validator		Object	Key would be the name of the validator, value would be the error message

HTTP status code summary

Text

200 - OK	         Everything worked as expected.
400 - Bad Request	 The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	 No valid API key provided.
403 - Forbidden	         The API key doesn't have permissions to perform the request.
404 - Not Found	         The requested resource doesn't exist.
409 - Conflict	         The request conflicts with another request
429 - Too Many Requests	 Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
5xx - Server Errors	 Something went wrong on Treevox's end. (These are rare.)