Enable or Disable Track Changes in Zoho Writer

Table of Contents

Note:

  • Each time the zoho.writer.documents.trackchanges integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.writer.documents.trackchanges integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Description

The zoho.writer.documents.trackchanges task enables or disables track changes option in the given document. This task is based on the Zoho Writer Enable/Disable Track Changes API.

Note: Applicable to all services except Zoho Creator.

Syntax

<response> = zoho.writer.documents.trackchanges(<document_id>, <enableTC>, <connection>);

where:

ParamsData typeDescription
<response>KEY-VALUEThe response returned by Zoho Writer. It represents if the status of track changes in the document.
<document_id>TEXT

The ID of the document for which track changes needs to be enabled/disabled.

The document ID can be obtained from the URL of the document from in which the Track Changes needs to be enabled or disabled.

The URL is in the following format: https://writer.zoho.com/writer/open/<document_id>

<enableTC>TEXT

1. If you would like to enable the Track Changes option for the document, pass the value as enable.
If during collaboration, the document owner or co-owner enables the Track Changes option for a particular file, it will be enabled for all users accessing the file.
If any of the collaborators (other than the owner or co-owner) enables the Track Changes option, it will only be enabled for that particular collaborator, and not for all users accessing the file.

2. If you would like to disable the Track Changes option for the document, pass the value as disable.

<connection>TEXT

The connection's link name.

Note:

  • To prevent new authtoken generation and ensure new integration tasks (created after the deadline specified in the post) work as expected, a Zoho OAuth connection with appropriate scopes is mandatory. Existing integration tasks will continue to work, with or without the connections parameter, until you manually delete the authtoken from Zoho Accounts.

  • Add relevant scopes from the Zoho Writer API when creating the connection.

  • Refer to this post for a list of Zoho services that support the Connections page.

  • Learn more about connections

Example

The following script enables track changes for the given Writer document.

document_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9";
enableTC = "enable";   //enable|disable
response = zoho.writer.documents.trackchanges(document_id, enableTC, "writer_oauth_connection");
info response;

where:

response
The KEY-VALUE response returned by Zoho Writer. It indicates whether Track Changes has been enabled or not.
"h36bc2a6c50b2754a405880c1d1679a5f5be9"
The TEXT that represents the ID of the document in Zoho Writer.
"enable"
The TEXT that represents whether track changes needs to be enabled or not.
"writer_oauth_connection"
The TEXT that represents the name of the connection.

Response Format

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

Related Links