Rename Document

Purpose

Using this API, you will be able to rename the document.

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.

Notes

Note: You can also rename the document 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={"name": "Online Word Processor"}'

Sample Response

Copied{
  "result": "success",
  "name": "Online Word Document",
  "message": "Document has been renamed successfully."
}

Deluge Snippet

Copieddocument_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9";
name = "Online Word Document";
response = zoho.writer.documents.setName(document_id, name, "writer_oauth_connection");
info response;