Add Or Update Document Title

Purpose

To add or update the document description.

Quick Reference

Property	Value
Method	POST
Request URL	https://{zohoapis_domain}/writer/api/v1/documents/{document_id}/meta
Scopes	ZohoWriter.documentEditor.ALL
Rate Limit	See Writer API throttle limits

Parameters

Path Parameters

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

Body Parameters

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

Notes

Note: You can also add or update the document description using this deluge task.
For possible errors, refer to error codes.

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."
}

Deluge Snippet

Copieddocument_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9";
Description = "Online Word Processor";
response = zoho.writer.documents.setDescription(document_id, Description, "writer_oauth_connection")
info response;