Add or Update Description in Zoho Writer
Table of Contents
Description
The zoho.writer.documents.setDescription task adds or updates your document with the description you provide. This task is based on the Zoho Writer Add or Update Description API.
Syntax
<response> = zoho.writer.documents.setDescription(<document_id>, <Description>, <connection>);
where:
Params | Data type | Description |
<response> | KEY-VALUE | The response returned by Zoho Writer. It reflects the status of the addition/update to the document's description. |
<document_id> | TEXT | The ID of the document for which the description needs to be added/updated. The document ID can be obtained from the URL of the document in which the description needs to be added or updated. The URL is in the following format: https://writer.zoho.com/writer/open/<document_id> |
<Description> | TEXT | Pass a string value for a description. |
<connection> | TEXT | The connection's link name. Note:
|
Example
The following script updates the description of the given Writer document.
document_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9"; Description = "Online Word Processor"; response = zoho.writer.documents.setDescription(document_id, Description, "writer_oauth_connection") info response;
where:
response
"h36bc2a6c50b2754a405880c1d1679a5f5be9"
"Online Word Processor"
"writer_oauth_connection"
Response Format
{ "result": "success", "description": "Online Word Processor", "message": "Document description has been updated successfully." }