Mark or Revert Final Documents in Zoho Writer
Table of Contents
Description
The zoho.writer.documents.MarkAsFinal task enables or disables editing in the document. This task is based on the Zoho Writer Mark/Revert Final Document API.
Syntax
<response> = zoho.writer.documents.MarkAsFinal(<document_id>, <markAsFinal>, <connection>);
where:
Params | Data type | Description |
<response> | KEY-VALUE | The response returned by Zoho Writer. It represents whether the document has been marked as final or not. |
<document_id> | TEXT | The ID of the document for which editing needs to be enabled/disabled. The document ID can be obtained from the URL of the document which needs to be marked or reverted as final. The URL is in the following format: https://writer.zoho.com/writer/open/<document_id> |
<markAsFinal> | BOOLEAN | 1. If you would like to mark the document as final, pass the value as true. 2. If you would like to revert the document from final, pass the value as false. |
<connection> | TEXT | The connection's link name. Note:
|
Example
The following script disables editing in the given Writer document.
document_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9"; markAsFinal = "true"; //true|false response = zoho.writer.documents.MarkAsFinal(document_id, markAsFinal, "writer_oauth_connection"); info response;
where:
response
"h36bc2a6c50b2754a405880c1d1679a5f5be9"
"true"
"writer_oauth_connection"
Response Format
{ "result": "success", "message": "The document has been marked as final." }