Hi Zoho Writer users,

The Merge and Store v1 API allows you to store the merged document in Zoho WorkDrive. The response of this API will be returned with the document's ID only after the merge is complete.

In Deluge, the maximum timeout for operation is 40 seconds. In some cases, the merge operation will exceed 40 seconds and the Deluge workflow may fail.

To overcome this problem we're introducing an advanced version of this API: Merge and Store v2 and sunsetting the v1 version of this API.

The Merge and Store v2 API will return the response immediately with a virtual document ID in which the merge operation will be scheduled in the background. Users can use this virtual ID and proceed with their workflow.

The parameters and scopes are same with the addition of merge_to optional key in the output_settings parameter. To know about the request URL and response structure please refer.

Here's how the response structure will be for v1 API and v2 API:

v1 API sample response

{
"document_id": "ponazfea04477109f4681a831e7177d96bc40",
"document_url": "http://writer.zoho.com/writer/open/ponazfea04477109f4681a831e7177d96bc40",
"status": “success”
}

v2 API sample response

{
    "merge_report_data_url": "<url>",
    "merge_report_url": "<url>",
    "records": [
        {
            "data": [{“given input merge_data”}],
            "download_link": "<attachment download url>",
            "document_id": "<merged doc id>",
            "document_url": "<merged doc open url>",
            "status": "inprogress"
        }
    ],
    "status": "inprogress"
}

We'll be sunsetting the Merge and Store v1 API on December 31, 2023. Please move to v2 API before this date to avoid any interruption in your workflow.

Please let us know if you have any questions.

Regards,