General Errors

Invalid parameter values (R2000)
Parameters not configured (R2001)
Parameters missing (R2003, R2009)
Invalid usage of parameters (R2004)
Invalid parameter length (R2005)
Invalid request size (R2006)
Invalid datatype (R2007, R2010)
Request URL not configured (R2008)
Unable to process JSON parameters (R2011)
Non-native resources are restricted (3049)
DMS not configured (R3501)
File size is more than 200MB (R3520)
Image count inside the document exceeds 200(R3521)
Unable to process the request (R5000)
Account inactive (R5001)
Account not confirmed (R5002)
IP not allowed or block-listed (R5003, R5004)
Remote IP locked (R5005)
Invalid method (R5006)
POST only URL(R5007)
Antivirus host unreachable (R5008)
XSS detected (R5009)
Unauthorised (R5010)
Invalid OAuthtoken (R5011)
Unsupported params (R5012)
Invalid ticket (R5013)
No sufficient previlege (R5014)
Unknown host (R5015)
Oauth Scopes missing (R5017)
Unable to get document information (R5018)

Invalid Parameter values

Error code

R2000

Error description

The parameter values entered are not valid.

Error Response

{
    "error": {
        "message": "Invalid parameter values found. Please try again with supported values.",
        "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": "R2000"
    }
}

Suggested action

Enter supported values for the parameters and try again.

Parameters not configured

Error code

R2001

Error description

Upload parameters are not configured properly.

Error Response

{
    "error": {
        "message": "Upload Parameters not configured properly. Please 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": "R2001”
    }
}

Suggested action

Configure the upload parameters and try again.

Parameter missing

Error code

R2003, R2009

Error description

A mandatory parameter to perform this action is missing.

Error Response

{
    "error": {
        "message": "You seem to be missing a mandatory parameter that's required to perform this action.",
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "parameter_name": “category",
        "errorcode": "R2003”
    }
}

Suggested action

Add the required parameter and then try to perform the action.

Invalid usage of the parameters

Error code

R2004

Error description

You have used the supported parameters multiple times (more than the limit).

Error Response

{
    "error": {
        "message": "You seem to have used the supported parameters multiple times.",
        "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": "R2004”
    }
}

Suggested action

Please check if any parameters are added multiple times in the request and try again.

Invalid parameter length

Error code

R2005

Error description

The length of the parameter has exceeded the limit.

Error Response

{
    "error": {
        "message": "The length of the parameter has exceeded the allowed limit. Please try again with a shorter one.",
        "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": "R2005”
    }
}

Suggested action

Please reduce the length (to a shorter one) of the parameter and try again.

Invalid request size

Error code

R2006

Error description

The size of the request has exceeded the limit.

Error Response

{
    "error": {
        "message": "Request size is more than the limit allowed. Please 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": "R2006”
    }
}

Suggested action

Please check if the request size is within the limit and try again.

Invalid datatype

Error code

R2007, R2010

Error description

You might have entered a wrong datatype for the parameters to perform this action.

Error Response

{
    "error": {
        "message": "DATATYPE mismatch. Please ensure you have the right DATATYPE for parameters to perform this action.",
        "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": "R2007”
    }
}

{
    "error": {
        "message": "Please ensure you have right DATATYPE for parameters.",
        "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": "R2010”
    }
}

Suggested action

Please ensure you have the right datatype for parameters to perform this action.

Request URL not configured

Error code

R2008

Error description

Request URL is not configured properly

Error Response

{
    "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”
    }
}

Suggested action

Please check if the request URL is correct and try again.

Unable to process JSON parameters

Error code

R2011

Error description

Unable to process JSON parameters or values.

Error Response

{
    "error": {
        "message": "An error occurred while processing JSON parameter or values. Please 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": "R2011”
    }
}

Suggested action

Please check if the input JSON parameters are properly sent along with the request and try again.

Non-native resources are restricted

Error code

R3049

Error description

This error is thrown when user tries to perform document related actions (like get document details, copy/download/publish/trash document and all Meta related operations) with non-native documents (like pdf,docx, otd, etc.,). As the non-native documents will be associated with their respective service, Writer will not have control over them.

Error Response

{
    "error": {
        "message": "This document is not a valid Writer resource. Please try again with a Writer resource.",
        "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": "R3049”
    }
}

Suggested action

Please try with a Writer document. To perform document related operation with non-native documents, try using Zoho WorkDrive Rest APIs.

DMS not configured

Error code

R3501

Error description

Document management system has not been activated for your account.

Error Response

{
    "error": {
       "message": "Document management service has not been activated for your account. Please access the onboard url link to active.",
       "documentation_url": "https://www.zoho.com/writer/help/api/v1/general-errors.html",
       "response_generated_time": 1616134261234,
       "request_url": "https://<invoked_api_request_url>“,
       "errorcode": "R3501",
       "onboard_url":"https://<onboard_request_url>"
   }
}

Suggested action

Please access the Onboard Url link to active. Onboard Url link will be provided in the response.

File size is more than 200 MB

Error code

R3520

Error description

This error will be thrown when the upload document size is more than 200 MB.

{
   "error": {
        "message": “Unable to process the document due to the size limitation of 200MB. Please reduce the file size and try again.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R3520”
    }
}

Suggested action

Please upload a document with file size less than 200 MB and try again.

Image count inside the document exceeds 200

Error code

R3521

Error description

This error will be thrown when the image count inside the document exceeds 200.

{
    "error": {
        "message": “Unable to process the document due to image count limitation of 200. Please delete some of the images and try again.”,
        "documentation_url": "https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html",
        "response_generated_time": 1594131798612,
        "request_url": “https://<invoked_api_request_url>",
        "errorcode": "R3521”
    }
}

Suggested action

Please delete some images from the document and try again.

Unable to process the request

Error code

R5000

Error description

Unable to process your request due to an error.

Error Response

{
    "error": {
        "message": "An error occurred while processing your request. Please check and try again later.",
        "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": "R5000”
    }
}

Suggested action

This may due to an internal error. Please try again after some time.

Account inactive

Error code

R5001

Error description

Your Zoho account seems to be inactive.

Error Response

{
    "error": {
        "message": "Your Zoho account seems to be inactive.”,
        "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": "R5001”
    }
}

Suggested action

Activate your Zoho account and try again.

Account not confirmed

Error code

R5002

Error description

Your Zoho account registeration has not been confirmed yet.

Error Response

{
    "error": {
        "message": "Your Zoho account has not been confirmed yet. Please confirm 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": "R5002”
    }
}

Suggested action

Confirm your Zoho account and try again.

IP not allowed or block-listed

Error code

R5003, R5004

Error description

You have performed this action using a blocked IP or an IP which is not allowed.

Error Response

{
    "error": {
        "message": "You have performed this action from a block-listed IP.”,
        "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": "R5003”
    }
}

{
    "error": {
        "message": "Your IP is not allowed to perform this action.”,
        "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": "R5004”
    }
}

Suggested action

Use an IP which is allowed (not blocked) to complete this action.

Remote IP locked

Error code

R5005

Error description

Number of requests exceeds the allowed limit.

Error Response

{
    "error": {
        "message": "Number of requests exceeds the allowed limit. Please try again later.”,
        "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": "R5005”
    }
}

Suggested action

This may due to an internal error. Please try again after some time.

Invalid method

Error code

R5006

Error description

The API method you used in your request is invalid. For example, you might have selected GET method in a POST request.

Error Response

{
    "error": {
        "message": "Posting method seems to be invalid. Please try again with valid method.”,
        "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": "R5006”
    }
}

Suggested action

Please use a valid method name and try again

POST only URL

Error code

R5007

Error description

This error is thrown when you try to access the URL using a different method instead of POST.

Error Response

{
    "error": {
        "message": "Please access the URL through POST method.”,
        "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": "R5007”
    }
}

Suggested action

Use only POST method to access the URL.

Antivirus host unreachable

Error code

R5008

Error description

Antivirus host is not reachable to do a virus check.

Error Response

{
    "error": {
        "message": "Antivirus host was not reachable to do a virus check.”,
        "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": "R5008”
    }
}

Suggested action

This may due to an internal error. Please try again after some time.

XSS detected

Error code

R5009

Error description

You have XSS content in your parameters.

Error Response

{
    "error": {
        "message": "You have XSS content in your parameters. Please verify 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": "R5009”
    }
}

Suggested action

Please verify the parameters and try again.

Unauthorised

Error code

R5010

Error description

You are not authorized to perform this operation. Permission denied.

Error Response

{
    "error": {
        "message": "Permission denied. You are not authorized to perform this operation.”,
        "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": "R5010”
    }
}

Suggested action

Please contact your administrator and obtain the access to perform the operation.

Invalid OAuthtoken

Error code

R5011

Error description

Invalid authorization header provided. The access_token you're using is either invalid or expired.

Error Response

{
    "error": {
        "message": "OAuthtoken or OAuthspace seems to be invalid. Please try again with a valid token.”,
        "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": "R5011”
    }
}

Suggested action

Create new access_token and try again.

Unsupported params

Error code

R5012

Error description

Your request has param types that are not supported in Writer API.

Error Response

{
    "error": {
        "message": "Unsupported parameters found. Please try again with supported parameters.”,
        "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": "R5012”
    }
}

Suggested action

Please enter valid parameter value and try again.

Invalid ticket

Error code

R5013

Error description

Your API request is not authenticated.

Error Response

{
    "error": {
        "message": "We failed to authenticate the API request. Please try with proper authentication.”,
        "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": "R5013”
    }
}

Suggested action

Please check and try with proper authentication.

No sufficient previlege

Error code

R5014

Error description

You are not having sufficient previlege to perform this operation

Error Response

{
    "error": {
        "message": "You do not have sufficient privileges to do this operation. Please contact your organization administrator.”,
        "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": "R5014”
    }
}

Suggested action

Please check with your organization administrator.

Unknown host

Error code

R5015

Error description

You are trying to connect with an unknown domain.

Error Response

{
    "error": {
        "message": "Uh-oh! You're trying to connect with an unknown domain. Please try again with a valid one.”,
        "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": "R5015”
    }
}

Oauth Scopes missing

Error code

R5017

Error description

Some oauth scopes are missing while generating oauthtoken to invoke the APIs.

Error Response

{
    "error": {
        "message": "Some oauth scopes seems to be missing. Please check and try again with a valid oauth scopes.”,
        "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": "R5017”
    }
}

Suggested action

Add the missing oauth scopes required for invoking particular API, regenerate the oauthtoken and try again.

Unable to get document information

Error code

R5018

Error description

This error occurs when you try to get the details of a document which is already trashed.

Error Response

{
    "error": {
        "message": "Document trashed. You can't perform this operation.”,
        "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": "R5018”
    }
}

Suggested action

Try to get the details for an existing document.

Note: If you still find any trouble, please write to us at: support@zohowriter.com.