Merge and Invoke

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Merges data into a Zoho Writer document template and executes the custom function configured in the template settings.


Merge Data: Provide exactly one of merge_data, merge_data_csv_content, merge_data_json_content, merge_data_csv_url, merge_data_json_url, or record_id.

Endpoints

OAuth Scope

ZohoWriter.documentEditor.ALLZohoWriter.merge.ALLWorkDrive.files.ALLCopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/merge/execute \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'output_settings={
  "format": "pdf",
  "merge_to": "separatedoc"
}' \
  -F 'merge_data={
  "data": [
    {
      "customer_name": "John Miller",
      "customer_email_address": "john.miller@zylker.com",
      "invoice_number": "INV-2026-045",
      "items": [
        {
          "items.item_code": "SKU-1001",
          "items.item_name": "Aria Smartwatch S2",
          "items.item_images": [
            "https://workdrive.zoho.com/external/sample-image-id-1/download?directDownload=True",
            "https://workdrive.zoho.com/external/sample-image-id-2/download?directDownload=True"
          ],
          "items.item_replacement": "Yes"
        }
      ]
    }
  ]
}' \
  -F 'merge_data_csv_content=@file_path' \
  -F 'merge_data_json_content=@file_path' \
  -F 'merge_data_csv_url=https://zylker.com/merge-data.csv' \
  -F 'merge_data_json_url=https://zylker.com/merge-data.json' \
  -F 'record_id=4876000000123456' \
  -F 'webhook_info={
  "url": "https://zylker.com/writer/execute-callback",
  "retry": 2,
  "timeout": 30000
}' \
  -F 'test_mode=true'

Path Parameters

document_idstring(Required)

The unique identifier of the Zoho Writer document template.

Request Body

multipart/form-data
output_settingsJSON Object(Optional)

Controls the file format, document name, merge type, and access protection of the merged document. When omitted, the output defaults to PDF format.

Hide Sub-Attributes
formatstring(Optional)

The file format of the merged document.

Allowed Values :
Show Values
pdfCopied!
docxCopied!
zdocCopied!
htmlCopied!
zipCopied!
zfdocCopied!
pdfformCopied!
Copied!Copy all as JSON Array
passwordstring(Optional)

An optional password to protect the merged document.

merge_tostring(Optional)

separatedoc produces a separate merged document for each record. singledoc combines all records into a single merged document.

Allowed Values :
Show Values
separatedocCopied!
singledocCopied!
Copied!Copy all as JSON Array
filenamestring(Optional)

A name for the merged document. Supports merge field placeholders, for example NDA_Agreement_<<ClientName>>.

Maximum Length :255255Copied!
sign_service_namestring(Optional)

The third-party e-signature service to which the merged PDF is uploaded for signing. Applicable only when format is pdf.

Allowed Values :
Show Values
adobesignCopied!
docusignCopied!
Copied!Copy all as JSON Array
restricted_accessJSON Object(Optional)

Applies permission-based restrictions to the merged document. When present, both password and permissions are required.

Hide Sub-Attributes
passwordstring(Required)

The password required to override the applied document restrictions.

Maximum Length :255255Copied!
permissionsarray(Required)

The list of actions to restrict in the merged document. document.copy restricts copying content, document.print restricts printing, document.edit restricts editing, and document.fill restricts filling form fields. Any action not listed remains unrestricted.

merge_dataJSON Object(Optional)

Inline merge data as a JSON object. Must contain a data key whose value is a JSON array of records, each being a key-value map matching the template's merge fields. For a subform field, use the subform's name as the key, mapped to an array of row objects; each row's keys follow the <subform_name>.<field_name> convention (e.g. items.item_code).

Hide Sub-Attributes
dataJSON Array(Required)

Array of records used to populate the template merge fields.

Hide Sub-Attributes
merge_data_csv_contentbinary(Optional)

A CSV file uploaded in the request body, up to 2 MB. Each row represents one merge record. Supported formats: csv.

merge_data_json_contentbinary(Optional)

A JSON file uploaded in the request body, up to 2 MB. Must contain an array of merge records. Supported formats: json.

merge_data_csv_urluri(Optional)

A publicly accessible URL pointing to a CSV file of merge records, up to 2 MB. Supported formats: csv.

merge_data_json_urluri(Optional)

A publicly accessible URL pointing to a JSON file of merge records, up to 2 MB. Supported formats: json.

record_idstring(Optional)

A record identifier from Zoho CRM, Zoho Creator, or Bigin. When provided, the API fetches merge data internally from the respective service.

Maximum Length :2525Copied!
webhook_infoJSON Object(Optional)

Configures a callback URL to receive the merge status and document details after the merge operation completes.

Hide Sub-Attributes
urluri(Optional)

The URL to which the merge status and document information are sent.

Maximum Length :255255Copied!
retryinteger(Optional)

The number of retry attempts if the webhook delivery fails.

Default Value :00Copied!
Minimum Value :00Copied!
Maximum Value :44Copied!
timeoutinteger(Optional)

The timeout in milliseconds for the webhook request.

Default Value :120000120000Copied!
Minimum Value :11Copied!
Maximum Value :120000120000Copied!
expiry_datelong(Optional)

The expiry timestamp, in epoch milliseconds, after which the webhook URL is no longer valid.

contextstring(Optional)

Arbitrary data that is echoed back in the webhook callback payload.

Maximum Length :10001000Copied!
test_modeboolean(Optional)

When true, the merge runs without consuming credit points. The output document will include a watermark. Limited to 50 merges per day per organization.

Body Parameters

Copied!
// Note: payload contains multiple type attributes

// type: object
output_settings = {
  "format": "pdf",
  "merge_to": "separatedoc"
}

// type: object
merge_data = {
  "data": [
    {
      "customer_name": "John Miller",
      "customer_email_address": "john.miller@zylker.com",
      "invoice_number": "INV-2026-045",
      "items": [
        {
          "items.item_code": "SKU-1001",
          "items.item_name": "Aria Smartwatch S2",
          "items.item_images": [
            "https://workdrive.zoho.com/external/sample-image-id-1/download?directDownload=True",
            "https://workdrive.zoho.com/external/sample-image-id-2/download?directDownload=True"
          ],
          "items.item_replacement": "Yes"
        }
      ]
    }
  ]
}

// type: file
merge_data_csv_content = <file>

// type: file
merge_data_json_content = <file>

// type: string(uri)
merge_data_csv_url = https://zylker.com/merge-data.csv

// type: string(uri)
merge_data_json_url = https://zylker.com/merge-data.json

// type: string
record_id = 4876000000123456

// type: object
webhook_info = {
  "url": "https://zylker.com/writer/execute-callback",
  "retry": 2,
  "timeout": 30000
}

// type: boolean
test_mode = true
Show full

Response Example

200
Copied!
  {
    "merge_report_data_url": "https://writer.zoho.com/writer/api/v1/merge/job/ba9cb8b6d826e05e26fd03c391dc4baa674281f9895988caf8420630887b5902/data",
    "merge_report_url": "https://writer.zoho.com/writer/v1/mailmerge/job/ba9cb8b6d826e05e26fd03c391dc4baa674281f9895988caf8420630887b5902",
    "records": [
      {
        "data": {
          "name": "Amelia",
          "email": "amelia@zylker.com"
        },
        "download_link": "https://writer.zoho.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/merge/download/gas3hfnkju456mndhjku987b",
        "status": "inprogress"
      }
    ],
    "status": "inprogress"
  }
                
Show full