Copy Document
Purpose
To retrieve a copy of a specific document.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/documents/{{document_id}}/copy
Path Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
document_id | String | Specify the unique id for the document. |
Body Parameters
Parameter | Data Type | Description |
Optional Parameters | ||
document_name | String | Specify a unique name for the copied document. By default, the document name will be "Copy of the Original document name". |
format | String | Specify the output format in which the copied file needs to be stored. Supported formats are: docx / zdoc / doc / odt / html / pdf and more ... Note:
|
password | String | Specify a password if you would like to protect the copied document. Note: This option is applicable only for docx and pdf files. |
folder_id | String | Specify the folder_id in which you would like to store the copy of the document. By default, the copied document will be stored under 'My Folders'. |
options | { "include_changes":<String>, "include_comments":<String>, "include_template_settings":<Boolean> } | include_changes -> Specify how the track changed content needs to be reflected in copied file. The possible values are:
include_comments -> Specify if the comments needs to be included in the copied file or not. The possible values are:
Note: This parameter is applicable only for docx and pdf files. include_template_settings -> Specify if the automation configuration needs to be included in the copied file or not. The possible values are True or False.
|
options
Parameter | Type | Possible Values | Default Value |
include_changes | String | as_markups / all / none | none |
include_comments | String | all / none | none |
include_template_settings | Boolean | true/false | none |
Note:
- The comments present in the document will be reflected in the copied document based on the comment visibility permission provided for that particular document.
- You can check the possible errors list here.
- This API is subject to throttle limits. For details on the applicable rate limits, please refer to this help link.