Enable/Disable Track Changes

Purpose 

Using this API, you will be able to enable or disable the track changes option for a document.

HTTP Request URL

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

Path Parameters

ParameterData TypeDescription
Mandatory Parameters
document_idStringSpecify the unique id for the Writer document.

Body Parameters

ParameterData TypeDescription
Mandatory Parameters

operations

JSONObject

Pass a String value (either enable or disable) through 'track_changes' key inside the JSONObject.

1. If you would like to enable the track changes option for the document, pass the value as 'enable'.

During collaboration, assume that the document owner or co-owner enables the track changes option for a particular file. In this case, the track changes feature will be enabled for all the users who are accessing that specific document.

If any of the collaborators (other than owner or co-owner) are opening the same document by enabling the track changes option, the feature will get reflected only for that particular collaborator and not for all the users who are accessing that file.

2. If you would like to disable the track changes option for the document, pass the value as 'disable'.

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={"track_changes": enable}'

Sample Response

Copied{
  "result": "success",
  "message": "Track changes enabled successfully."
}