How to Migrate from Merge and Store V1 to V2?
Why Migrate to Merge and Store V2 API?
In Merge and Store V1 API, the response is returned only after the merge operation is fully completed. However, in Deluge scripts, the maximum allowed timeout is 40 seconds. In cases where the merge takes longer, this leads to a timeout and causes the DRE workflow to fail.
To overcome this limitation, Merge and Store V2 API was introduced. In V2:
- The response is returned immediately with a virtual RID, even before the merge is completed.
- The merge operation is scheduled in the backend, and the merged document will be stored using the virtual RID.
- Users can proceed with their workflow using the virtual RID. Temporary content will be available until the final merge completes.
To track the merge status, you can use either of the following response fields:
- merge_report_data_url
- merge_report_url
The parameters and scopes remain the same as in Merge and Store V1. Additionally, V2 introduces a new optional key called merge_to inside the 'output_settings' parameter to define where the merged document should be stored.
How to Migrate from Merge and Store V1 to V2?
To migrate from Merge and Store V1 to V2, follow these key changes:
- Endpoint Update: Update the API endpoint to: https://{zohoapis_domain}/writer/api/v2/documents/{{document_id}}/merge/store
- HTTP Method: POST
- Payload Format: Pass merge data and configuration inside a JSON request body.
- Response Handling: Provides structured JSON responses with detailed status for each merged document.
For full API details, refer to the documentation: Merge and Store V2 API
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
How to create workflow rules in Zoho CRM to perform mail merge tasks
You can automate your Writer's mail merge tasks by creating Workflow rules in your Zoho CRM. Say, for example, you want to automate the merge and send task for every lead entry in your Zoho CRM account (merge every lead entry send an email ...How to track merge status and handle errors in Zoho Writer
Overview You can track the status of the merge jobs using email notifications and the merge logs. While email notifications help you track the merge initiation and completion status, the merge logs help you track the status of jobs in progress, along ...Getting started with document merge in Zoho Writer
Overview Template-based document generation in Zoho Writer allows you to automate the creation of personalized documents by connecting pre-designed templates with structured data sources such as spreadsheets, forms, CRMs, or APIs. Each template ...How to merge and store documents in Zoho Writer
Overview Merge and Store option allows you to automatically generate and save personalized documents for each record in your connected data source. Once the merge is complete, each document is stored individually in the location of your choice—such ...How to create charts with merge field data during merge
Overview Zoho Writer lets you insert dynamic charts into merge templates, so that when you generate personalized documents (via Mail Merge), each document can display data-driven visualizations instead of just plain text. Common chart types such as ...
New to Zoho LandingPage?
Zoho LandingPage Resources