Mark Or Revert Final Document

Purpose

Using this API, you can either mark the document as final after the editing process is completed or revert it back if more editing is required.

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 boolean value (either true or false) through 'mark_as_final' key inside the JSONObject. 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'.

Notes

Note: You can also enable or disable editing in 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={"mark_as_final": true}'

Sample Response

Copied{
  "result": "success",
  "message": "The document has been marked as final."
}

Deluge Snippet

Copieddocument_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9";
markAsFinal = "true";  //true|false
response = zoho.writer.documents.MarkAsFinal(document_id, markAsFinal, "writer_oauth_connection");
info response;