API Errors

Zoho Writer APIs uses HTTP status codes to display the result of an API call. 2xx class codes are success codes, 4xx class codes occur when the information provided by the client is incorrect, and 5xx class codes indicate server side errors.

The HTTP status codes that are commonly used are listed below.

Status CodeDescription
200OK
201Created
400Bad Request
401Unauthorized
404URL Not Found
405Method Not Allowed
429Rate Limit Exceeded
500Internal Error

In addition to the status code, when a request fails, Zoho Writer APIs return an error in the following JSON format:

{
  "error": {
    "message": "<error_message>",
    "documentation_url": "<documentation_url>",
    "response_generated_time": "<timestamp_in_milliseconds>",
    "request_url": "<invoked_api_request_url>",
    "errorcode": "<error_code>"
  }
}

The error codes for each API operation are listed in the tables below.

General Errors

Error CodeDescriptionSuggested Action
R2000The parameter values entered are not valid.Enter supported values for the parameters and try again.
R2001Upload parameters are not configured properly.Configure the upload parameters and try again.
R2003, R2009A mandatory parameter to perform this action is missing.Add the required parameter and then try to perform the action.
R2004You have used the supported parameters multiple times (more than the limit).Check if any parameters are added multiple times in the request and try again.
R2005The length of the parameter has exceeded the limit.Reduce the length of the parameter and try again.
R2006The size of the request has exceeded the limit.Check if the request size is within the limit and try again.
R2007, R2010You might have entered a wrong datatype for the parameters to perform this action.Ensure you have the right datatype for parameters to perform this action.
R2008Request URL is not configured properly.Check if the request URL is correct and try again.
R2011Unable to process JSON parameters or values.Check if the input JSON parameters are properly sent along with the request and try again.
R3000This error occurs due to unexpected issues while invoking any Zoho Writer APIs.Retry the request after a short interval. If the issue persists, contact support for further assistance.
R3049Non-native documents (PDF, DOCX, OTD, etc.) are not supported for document-related operations.Try with a Writer document. To perform operations with non-native documents, use Zoho WorkDrive Rest APIs.
R3501Document management system has not been activated for your account.Access the Onboard URL link provided in the response to activate DMS.
R3520The upload document size is more than 200 MB.Upload a document with file size less than 200 MB and try again.
R3521The image count inside the document exceeds 200.Delete some images from the document and try again.
R5000Unable to process your request due to an error.This may be due to an internal error. Please try again after some time.
R5001Your Zoho account seems to be inactive.Activate your Zoho account and try again.
R5002Your Zoho account registration has not been confirmed yet.Confirm your Zoho account and try again.
R5003, R5004You have performed this action using a blocked IP or an IP which is not allowed.Use an IP which is allowed (not blocked) to complete this action.
R5005Number of requests exceeds the allowed limit.Try again after some time.
R5006The API method you used in your request is invalid.Please use a valid method name and try again.
R5007You tried to access the URL using a different method instead of POST.Use only POST method to access the URL.
R5008Antivirus host is not reachable to do a virus check.This may be due to an internal error. Please try again after some time.
R5009You have XSS content in your parameters.Verify the parameters and try again.
R5010You are not authorized to perform this operation. Permission denied.Contact your administrator and obtain the access to perform the operation.
R5011Invalid authorization header provided. The access_token is either invalid or expired.Create new access_token and try again.
R5012Your request has param types that are not supported in Writer API.Enter valid parameter value and try again.
R5013Your API request is not authenticated.Check and try with proper authentication.
R5014You are not having sufficient privilege to perform this operation.Check with your organization administrator.
R5015You are trying to connect with an unknown domain.Try again with a valid domain.
R5017Some oauth scopes are missing while generating oauthtoken to invoke the APIs.Add the missing oauth scopes, regenerate the oauthtoken, and try again.
R5018This error occurs when you try to get the details of a document which is already trashed.Try to get the details for an existing document.

Create Document

Error CodeDescriptionSuggested Action
R1000, R1001Invalid import URLUnable to import the required file. This may occur when you're trying to import a file from an invalid web URL.
R1002Unsupported file extensionThe file you're trying to import has an unsupported extension.
R1007File size exceededThe size of the file you're trying to upload has exceeded the maximum file size supported by Writer.
R1008Unsupported content typeThe file you're trying to import has an unsupported content-type.
R1009Virus detectedThe file you're trying to import via the web URL seems to contain a virus.
R1010Document conversion failureThe file that you're trying to upload could not be converted or imported in Writer.
R1013Uploaded document is corruptedThe file which you are trying to upload is corrupted.
R1014Password not providedThe document imported seems to be password protected and the password is not provided.
R1015Invalid passwordThe document imported seems to be password protected and the provided password is incorrect.
R1016File format not supportedThe file format (MS Word 97 or older) of the uploaded file is not supported.
R2005Filename is too largeThe length of the filename provided exceeded the allowed limit.

Copy Document

Error CodeDescriptionSuggested Action
R3040Unable to copy/duplicate the document.Try again in a while.
R3042Unable to copy document as there is no permission for that particular folder.Ensure you have sufficient permissions to save files to the target folder.
R3049Copy restricted for non-native Writer documents.Try again with a valid Writer resource.
R3054Unable to copy document as download permission is restricted.Contact your team admin to enable downloads.
R4706Copy restricted as the document is in draft state.Mark the document as ready before copying.
R5010You are not authorized to perform this operation. Permission denied.You do not have permission to perform this action.

List Documents

Error CodeDescriptionSuggested Action
R2000The value specified for the params is invalid or you have used the params that are not configured properly.Please set the value with respect to the available limit and try again.
R2010The data type of the parameter is invalid.Set a valid param data type in your API request and try again.
R3003Unable to fetch the list of documents.This may be due to an internal error. Please try again after

Download Document

Error CodeDescriptionSuggested Action
R3001The user does not have sufficient privileges to download the document. This may be due to an organization policy restriction.Please contact your organization administrator.
R3002Unable to download the document. This may be due to an internal server error.Please try again after some time.
R5010The user might not have enough permission to download the document.Downloading could be restricted if the user does not have access to the document or has only read-only permissions. Change the permissions and try again.

Convert Document

Error CodeDescriptionSuggested Action
R2009You have missed the mandatory parameter in your API request.Please make sure you provide the document format to be converted in your API request and try again.

Update Document Metadata

Error CodeDescriptionSuggested Action
R3009Unable to update the document description.This might be due to an internal error. Please try again after some time.
R3010Unable to make the document as favourite.This might be due to an internal error. Please try again after some time.
R3011Unable to mark the document as final.This might be due to an internal error. Please try again after some time.
R3012Unable to lock the document.This might be due to an internal error. Please try again after some time.
R3013Unable to unlock the document.This might be due to an internal error. Please try again after some time.
R3014While trying to lock a document which is already locked, it throws this error code.Please confirm if the document is already locked.
R3015While trying to unlock a document which is not locked yet, this error code will be thrown.Please confirm if the document is locked and then try to unlock it.
R3016While trying to unlock a document which is locked by a different user, it throws this error code.Please check with the admin of the document to get access to it.
R3017Unable to complete the lock operation.This might be due to an internal error. Please try again after some time.
R3027Unable to remove the document from favourite list.This might be due to an internal error. Please try again after some time.
R3028Unable to revert the document which is marked as final to edit more.This might be due to an internal error. Please try again after some time.
R3029Unable to rename the document.This might be due to an internal error. Please try again after some time.
R3301Your request will not be processed at the moment due to a temporary server error.This might be due to an internal error. Please try again after some time.
R3303An error while trying to publish your post.This might be due to an internal error. Please try again after some time.
R3305Unable to publish your post at the moment due to a temporary server error.This might be due to an internal error. Please try again after some time.
R3306Unable to publish your post as there was an error connecting to your account.This might be due to an internal error. Please try again after some time.
R3307A temporary error while scheduling your post.This might be due to an internal error. Please try again after some time.
R3308Your request will not be processed at the moment due to a temporary server error.This might be due to an internal error. Please try again after some time.

Document Operations

Error CodeDescriptionSuggested Action
R3005Unable to delete the document.This might be due to an internal error. Please try again after some time.
R3008Unable to retrieve the document details.This might be due to an internal error. Please try again after some time.
R3018Unable to move the document to trash.This might be due to an internal error. Please try again after some time.
R3032Unable to restore the document.This might be due to an internal error. Please try again after some time.
R3039This error occurs while you are trying to delete or move a document to trash when the trashing process is already taking place in the backend.Please try again after the backend trashing process is completed.
R3047This error occurs when you are trying to trash a document which is already moved to trash.(No explicit suggested action provided)
R3048This error occurs when you try to delete the document permanently before trashing it.Please trash the document before deleting it permanently.
R5010User does not have enough permission or access to delete the document.Please make sure you have provided your own document. If it is a document from the team folder, please contact the admin/owner of the document to provide the required permission and try again.

Templates

Error CodeDescriptionSuggested Action
R3033Limit value provided to retrieve templates list has exceeded the supported count.You can only fetch a maximum of 100 templates at a time. Please provide a value below the supported limit and try again.
R3500Problem in listing the available templates.Try again later. If the issue persists, contact support.
R3502Problem in creating a new template.Try again later. If the issue persists, contact support.
R3503Problem in duplicating a template.Try again later. If the issue persists, contact support.
R3504Unable to retrieve the template details.Try again later. If the issue persists, contact support.
R3505Org templates are not supported for your account.Org templates are supported only for Zoho Workdrive users. Please upgrade to Workdrive to access this feature.
R3507Problem in deleting the template.Try again later. If the issue persists, contact support.
R3512Problem in listing the public templates.Try again later. If the issue persists, contact support.
R3513Problem in renaming the template.Try again later. If the issue persists, contact support.
R3514Problem in updating the template description.Try again later. If the issue persists, contact support.
R3515Problem in updating the template properties.Try again later. If the issue persists, contact support.

Merge

Error CodeDescriptionSuggested Action
R6000Internal server error occurred while processing merge request.Contact Zoho Writer support at support@zohowriter.com.
R6001Merge data is not provided.Provide valid merge data and try again.
R6002Document to be merged with data is not provided.Provide a valid document file and try again.
R6003Recipient email parameter is not passed or email address is not saved in settings.Pass the 'recipient_email' parameter or save the email address in settings.
R6004Signer data parameter is not provided or signer details are not saved in settings.Provide valid signer details or save them in settings.
R6006Signer info provided is invalid (e.g., 'field_id' not given).Verify and provide complete signer info with all required fields.
R6007Unique attachment parameter value is passed incorrectly.Verify and pass the unique attachment info correctly.
R6008In-person signer info is not passed.Provide the required in-person signer information.
R6009Recipient's email address does not belong to your organization's domain.Use an email address from your organization's domain.
R6010Verification info key value is passed incorrectly.Verify and pass the verification info with correct values.
R6011Maximum daily merge limit has been reached for your account.Try again after 24 hours or contact support for higher limits.
R6012Maximum daily email send limit has been reached.Try again after 24 hours or contact support for higher limits.
R6013Monthly credit points limit for merge operations has been reached.Purchase additional credit points to continue merging.
R6014Merge data count has exceeded the limit (max 5 for normal sign flow).Reduce merge data count to within the allowed limit.
R6016Document content exceeds 1,500,000 characters limit.Reduce document size or split into multiple documents.
R6017Daily test mode merge limit has been reached.Try again after specified hours or upgrade to production.
R6021Not authorized to save file in the specified folder.Verify you have the required permissions for the folder.
R6022Not authorized to use the specified 'From' email address.Use an authorized 'From' email address.
R6031Required scope is missing for uploading merged file to folder.Add appropriate Docs or WorkDrive scope to your configuration.
R6033Account is not synced with the Sign service.Sync your account with Sign service and try again.
R6041Error occurred while merging file with provided merge data.Verify merge data is valid and properly formatted, then try again.
R6044'id' field is missing from merge data for CRM templates.Add the 'id' field with CRM record ID in merge data (e.g., {"name": "John", "email": "john@example.com", "id": "1234567789"}).
R6053Replacing existing files is not supported for Zoho Docs users.Upgrade to WorkDrive to enable file replacement feature.
R6054Custom function is not configured in the merge template.Configure the required custom function in your template.
R6069Upload document size exceeds 200 MB limit.Reduce document size to below 200 MB and try again.
R6070Document contains more than 200 images.Delete some images from the document to reduce count below 200.
R6099Zoho Docs folder ID was passed to store merged documents (Zoho Docs is deprecated).Use a WorkDrive folder ID instead to store merged documents.

Send Document for Signing

Error CodeDescriptionSuggested Action
R8001Mandatory parameters missingProvide required parameters: recipient email address and signed_document_name
R8002Unable to create a new sign requestRetry the operation after checking request parameters for server issues or invalid configuration
R8003Invalid accountCreate an account in Zoho Sign service and try again
R8004, R8103Zoho Sign credits exhaustedUpgrade your license to send more documents for sign
R8005Unable to generate OAuth TokensCheck configured OAuth scopes or access the Sign configuration dialog from UI before using the API
R8006Signer name not foundProvide a valid in-person signer name
R8007Signer email address not foundProvide a valid in-person signer email address or choose a different verification type
R8008Verification code not foundProvide a valid verification code for offline signer verification
R8009Verification code limit exceededProvide a verification code that is exactly 6 characters long
R8010Recipient country code not foundProvide a valid country code for phone-based verification or delivery
R8011Recipient phone number not foundProvide a valid recipient phone number
R8012Invalid recipient email addressUse a valid email address of an active organization member for in-person signing
R8014Insufficient permissionUpgrade your plan to support the Approver role
R8015Recipients email addresses are emptyProvide valid email addresses for all recipients
R8016Credit points limit has exceededPurchase more credit points to continue merge operations
R8017Daily limit has reachedFill the limit extension form to increase daily API limits
R8019OAuth information not foundOpen the sign configuration dialog once and try using the API again
R8020Phone number differsUse the same phone number for both recipient verification and delivery
R8021Country code differsUse the same country code for both verification and delivery details
R8022Zoho Sign account does not existCreate a Zoho Sign account and try again
R8101Unable to upload the documentCheck upload settings and try again
R8102No signer fields for the recipientsAdd at least one signer field for each recipient in the document
R8104Invalid Zoho Sign org idProvide a valid organization ID

Combine

Error CodeDescriptionSuggested Action
R6013This error occurs when the credit points limit has been reached for your organization.Purchase more credit points to continue.
R7500This may be due to an internal error.Please try again after some time.
R7501This error is thrown when the input PDF files are not passed.Check and try again with input files.

Publish

Error CodeDescriptionSuggested Action
R3019Unable to unpublish the document from the web.This might be due to an internal error. Please try again after some time.
R3020Unable to unpublish the document within the organization.This might be due to an internal error. Please try again after some time.
R3021Attempting to unpublish a document that has not been published.Publish the document first, then unpublish it.
R3022Unable to publish the document externally.This might be due to an internal error. Please try again after some time.
R3023Unable to publish the document within the organization.This might be due to an internal error. Please try again after some time.
R5002Your Zoho account has not been confirmed yet.Confirm your account and try again.
R5014User does not have access or sufficient privilege to perform the operation.Contact your organization administrator to obtain access or change permission settings.

Translate Document

Error CodeDescriptionSuggested Action
R9101Document exceeds the 20,000-character limit.Reduce document size to within 20,000 characters and retry.
R9102Insufficient permission to translate the document.Contact your administrator to request translation permissions.
R9103File format is not supported for translation.Use a supported document format and retry.