Merge API - Possible error codes

JSON Object Syntax:

In addition to the default 'error' key mentioned in general syntax , below keys are also applicable for Merge API responses.

{ 
    "error": {
          "message": "Merge data not found. Please try again with proper merge data.”,
          "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": "R6001"
          },
     "error_collection": [
              {
                 "message": "Permission denied. You are not authorized to save a file in the given folder.",
                 "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": "R6021"
              },
             {
                 "message": "Invalid unique attachment info. Please try again with proper unique attachment info.",
                 "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": "R6007"
             }
       ],
     "warning_collection": [
              {
              "Field not found in merge data": [ "Products","Company", "Last_Name"],
              "message": "This merge field will be removed as it is not found in the merge data.",
              "documentation_url": "https://www.zoho.com/writer/help/api/v1/merge-api-possible-error-codes.html",
              "errorcode": "R6071"
              }
      ]
}

KeysDescription
errorThe primary cause of the merge operation failure will be returned in this key.
error_collectionThis key will be present if additional errors are detected during the merge operation. If this key is included in the response, the user should review and resolve these errors before reattempting the API call, after addressing the primary error.
warning_collection

This key will be present if there are missing or misconfigured values that do not cause the merge operation to fail but may affect the output document. For example, some field values might not be replaced correctly due to incorrect input merge data.

The user can review these warnings and decide whether to fix them if necessary, or proceed without changes.

Notes:

  1. The 'error_collection' and 'warning_collection' keys will not be present in all cases.
  2. The 'warning_collection' key will be applicable for both success and failure merge cases.

General error

Error code

R6000

Error description

This might be due to an internal server error. Please write to us at: support@zohowriter.com.

Error Response

{
    "error":  {
        "message": “An error occurred while processing your merge 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": "R6000”
    }
}

Merge data is missing

Error code

R6001

Error description

The above error occurs when merge data is not provided.

Error Response

{
   "error":  {
        "message": "Merge data not found. Please try again with proper merge data.”,
        "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": "R6001”
    }
}

File is not found

Error code

R6002

Error description

This error is thrown when the document to be merged with the data is not provided.

Error Response

{
   "error":  {
        "message": "File not found. Please try again with proper file.”,
        "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": "R6002”
    }
}

Email address not found

Error code

R6003

Error description

This error occurs when the 'recipient_email' parameter is not passed or when the email address is not saved in the settings.

Error Response

{
   "error":  {
        "message": "Email address not found. Please try again with proper email address.”,
        "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": "R6003”
    }
}

Signer Email address not provided

Error code

R6004

Error description

This error occurs when the 'signer_data' parameter is not provided or when the signer details are not saved in the settings.

Error Response

{
   "error":  {
        "message": "Signer info not found. Please try again with proper signer email address.”,
        "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": "R6004”
    }
}

Invalid Signer Info

Error code

R6006

Error description

This error occurs when the signer info provided in invalid (like 'field_id' not given).

Error Response

{
    "error":  {
        "message": “Invalid signer info. Please try again with proper signer info.”,
        "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": "R6006”
    }
}

Invalid unique attachment info

Error code

R6007

Error description

This error occurs when the unique attachment param value is passed incorrectly.

Error Response

{
    "error":  {
        "message": “Invalid unique attachment info. Please try again with proper unique attachment info.”,
        "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": "R6007”
    }
}

Daily merge limit has exceeded

Error code

R6011

Error description

Maximum limit for merging the documents has reached for the day.

Error Response

{
  "error":  {
        "message": "Daily merge limit reached. 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": "R6011”
    }
}

Daily email limit has exceeded

Error code

R6012

Error description

Maximum limit for sending the merged documents via email has reached for the day.

Error Response

{
    "error":  {
        "message": "Daily email limit reached. 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": "R6012”
    }
}

Credit points limit has exceeded

Error code

R6013

Error description

Maximum limit for performing the merge operations for your organisation has reached for the month.

Error Response

{
    "error":  {
        "message": "Credit points limit reached for your organisation. Please purchase more credit points to continue.",
        "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": "R6013”
    }
}

Merge data count has exceeded

Error code

R6014

Error description

This error occurs when the merge data count has exceeded. For normal sign flow, the merge data value should not be greater than 5.

Error Response

{
    "error":  {
        "message": “Merge data count is exceeded. Please check the documentation and pass valid data.”,
        "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": "R6014”
    }
}

Sign limit has reached

Error code

R6015

Error description

This error occurs when the monthly sign limit for your organisation has reached.

{
    "error":  {
        "message": “Monthly sign document limit reached for your organisation. Please upgrade your account to continue.”,
        "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": "R6015”
    }
}

Document content limit has exceeded

Error code

R6016

Error description

This error is thrown for all Merge APIs when the document content exceeds more than 7 lakh characters.

{
    "error":  {
        "message": “Document is too large. Exceeds the limit of 0.7 million(700k) characters.”,
        "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": "R6016”
    }
}

Daily merge (test_mode) limit has exceeded

Error code

R6017

Error description

Maximum limit to test the Merge APIs has reached for the day.

{
    "error":  {
        "message": “Daily merge (test_mode) limit has reached. Please try again after X hour(s).”,
        "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": "R6017”
    }
}

Unable to save the file in a particular folder

Error code

R6021

Error description

This error occurs when you are not authorised to save the file in that particular folder.

Error Response

{
    "error":  {
        "message": "Permission denied. You are not authorized to save a file in the given folder.”,
        "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": "R6021”
    }
}

Unable to send email using the 'From' address

Error code

R6022

Error description

This error occurs when you are not authorised to use the 'From' email address.

Error Response

{
    "error":  {
        "message": "Permission denied. You are not authorized to use the given 'From' address.",
        "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": "R6022”
    }
}

Unable to upload the merged file in a folder

Error code

R6031

Error description

This error occurs when the required scope is not added. Include Docs/Workdrive scope based on the folder in which you would like to upload the file.

Error Response

{
    "error":  {
        "message": "An error occurred while uploading the merged file in a folder. 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": "R6031”
    }
}

Unable to access Sign

Error code

R6033

Error description

This error occurs when your account is not synced with the Sign service.

Error Response

{
    "error":  {
        "message": "Looks like your account is not linked with Sign service. 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": "R6033”
    }
}

Unable to merge the document

Error code

R6041

Error description

This error occurs while merging the file with the given merge data.

Error Response

{
    "error":  {
        "message": “An error occurred while merging the file with the given merge data. 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": "R6041”
    }
}

Invalid merge date for CRM templates

Error code

R6044

Error description

This error occurs when Email API request for CRM templates are sent without including 'id' field in merge data.

Error Response

{
    "error":  {
        "message": “Invalid merge data for crm template. Please add id field in merge data 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": "R6044”
    }
}

Suggested action 

Pass the record id value for each record inside the key 'id' for each data and try again.
For example: merge_data = {data: [{"name": "Amelia", "email": "amelia@zylker.com", "id": "1234567789"}]} // 1234567789 - CRM record id

Unable to replace an existing file

Error code

R6053

Error description

This error is thrown when a Zoho Docs user tries to replace an existing file. Because, this feature/option is supported only for Zoho WorkDrive users.

{
    "error":  {
        "message": “Replacing existing file is currently not supported for your account. Please check and upgrade to Workdrive.”,
        "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": "R6053”
    }
}

Custom function not configured

Error code

R6054

Error description

This error will be thrown when the user tries Merge and Invoke API without configuring the custom funtion.

{
    "error":  {
        "message": “Custom function not configured in the template. Please configure 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": "R6054”
    }
}

File size is more than 200 MB

Error code

R6069

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": "R6069”
    }
}

Image count inside the document exceeds 200

Error code

R6070

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": "R6070”
    }
}

Unable to store the merged documents in Zoho Docs folder

Error code

R6099

Error description

This error will be thrown when Zoho Docs folder ID is passed to store the merged documents. Because, Zoho Docs is deprecated.

{
    "error":  {
        "message": “Zoho Docs is discontinued. Please use the WorkDrive folder ID to store all your merged documents.”,
        "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": "R6099”
    }
}