Merge Document

Purpose

This API will allow you to generate documents and merge them.

HTTP Request URL

https://{zohoapis_domain}/writer/api/v1/documents/{{document_id}}/merge

Path Parameters

ParameterData TypeDescription
Mandatory Parameters
document_idStringSpecify a unique id for the writer document.

Body Parameters

ParameterData TypeDescription
Mandatory Parameters
output_formatStringSupported formats are pdf, pdfformdocx, html, zfdoc and zip (only html). Specify a format in which you would like to download the merged document.
You can provide the data in any one of the below formats
merge_dataJSONObjectPass a String value through 'data' key as JSON Array.
merge_data_csv_contentFileProvide the required csv content in your API request body.
merge_data_json_contentFileProvide the required json content in your API request body.
merge_data_csv_urlurlProvide the required csv url in your API request body.
merge_data_json_url urlProvide the required json url in your API request body.
Optional Parameters
passwordStringSpecify a password if you would like to protect the merged document.
response_typeString

Specify the response_type value as "link" to download the document using a link.

filenameString

Specify a name (without extension) for the merged document that needs to be downloaded.

For example: "filename = test" (extension will be automatically added based on the provided 'output_format')

Note:

Sample Request


				curl --location --request POST "https://zohoapis.com/writer/api/v1/documents/ponazfea04477109f4681a831e7177d96bc40/merge" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form "output_format=pdf" \
  --form "password=***" \
  --form "merge_data={\"data\":[{\"name\":\"Amelia\",\"email\":\"amelia@zylker.com\"}]}"			

Sample Response

The document will be downloaded in the form of bytes.

If the 'response_type' parameter is passed, the response will be as the following:

 


				{ 
   URL : https://writer.zoho.com/writer/api/v1/documents/ponazfea04477109f4681a831e7177d96bc40/merge/download/gas3hfnkju456mndhjku987b
 }