Download Document
The Writer API allows to download docs that are stored in your Writer account. You can download files in docx, odt, rtf, txt, html and pdf formats. To download a document, you should make an authorized HTTP GET request by including the document_id and format parameters. The document will be downloaded in docx format by default if you don't specify this parameter in your API request.
Purpose
To download the document in the specified format.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/download/{{document_id}}
Path Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
document_id | String | Specify the unique id of the document to be downloaded. |
Query Parameters
Parameter | Data Type | Description |
Optional Parameters | ||
format | String | Specify the format in which the document needs to be downloaded. By default, the document will be downloaded in 'docx' format.
|
options | { "include_changes":<String>, "include_comments":<String>, "include_styles":<String> } | include_changes -> Specify how the track changed content needs to be reflected in downloaded file. The possible values are:
include_comments -> Specify if the comments needs to be included in the downloaded file or not. The possible values are:
Note: This parameter is applicable only for docx and pdf files.
include_styles-> Specify if the styles needs to be included in the downloaded file or not. The possible values are:
Note: This parameter is applicable only for html and zip files. |
sign_service_name | String | This param needs to be configured when you would like to upload the downloaded document with signer fields to a third party sign service.
Possible values: zohosign, adobesign and docusign.
Default value for this param will be zohosign.
Note: This param can be used only when the 'format' param value is configured as pdf. |
password | String | Specify a password if you wish to protect the downloaded document.
|
options
Parameter | Type | Possible Values | Default Value |
include_changes | String | as_markups / all / none | none |
include_comments | String | all / none | none |
include_styles | String | as_inline / none | as_inline |
Notes:
- To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.documentEditor.ALL, ZohoPC.files.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALL
- The comments present in the document will be reflected in the downloaded document based on the comment visibility permission provided for that particular document.