Add or update document description

Add/Update Document Description

Purpose

To add or update the document description.

HTTP Request URL

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

Path Parameters

Parameter	Data Type	Description
Mandatory Parameters
document_id	String	Specify the unique id for the Writer document.

Body Parameters

Parameter	Data Type	Description
Mandatory Parameters
operations	JSONObject	Pass a String value through 'description' key inside the JSONObject.

Note: You can also add or update the document description using this deluge task.

Sample Request

Copiedcurl -X POST \
  https://www.zohoapis.com/writer/api/v1/documents/h36bc2a6c50b2754a405880c1d1679a5f5be9/meta \
  -H 'Authorization: Zoho-oauthtoken xxx.yyy.zzz' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F 'operations={"description": "Word Processor"}'

Sample Response

Copied{
  "result": "success",
  "description": "Online Word Processor",
  "message": "Document description has been updated successfully."
}