Errors

Writer APIs returns the error information in two levels:

HTTP error codes and messages in the header.
A JSON object in the response body with additional details that can help you determine how to handle the error.

JSON Object Syntax:

{
    "error": {
        "message": "Request URL not configured properly. Please check and try again",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R2008"
    },
}

Keys	Description
error	The primary cause of failure for the invoked API will be returned in this key.
message	An error description.
documentation_url	The document link which consists of the necessary information about the error.
response_generated_time	The API response generated time in milliseconds.
request_url	The HTTP request URL which is used to invoke our APIs.
errorcode	An unique errorcode.
parameter_name	The problematic parameter name will be returned. It will not be available in all cases.

In the upcoming sections, you can find the JSON representation of every possible error and a suggested action that can be taken to handle these errors.