How to Migrate from Merge and Store API from V1 to V2?

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



        Create. Review. Publish.

        Write, edit, collaborate on, and publish documents to different content management platforms.

        Get Started Now


          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 CRM Training
              Redefine the way you work
              with Zoho Workplace

                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 CRM Training

                  Create, share, and deliver

                  beautiful slides from anywhere.

                  Get Started Now


                    Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                    BOOK A SESSION







                                Quick LinksWorkflow AutomationData Collection
                                Web FormsEnterpriseOnline Data Collection Tool
                                Embeddable FormsBankingBegin Data Collection
                                Interactive FormsWorkplaceData Collection App
                                CRM FormsCustomer ServiceAccessible Forms
                                Digital FormsMarketingForms for Small Business
                                HTML FormsEducationForms for Enterprise
                                Contact FormsE-commerceForms for any business
                                Lead Generation FormsHealthcareForms for Startups
                                Wordpress FormsCustomer onboardingForms for Small Business
                                No Code FormsConstructionRSVP tool for holidays
                                Free FormsTravelFeatures for Order Forms
                                Prefill FormsNon-Profit

                                Intake FormsLegal
                                Mobile App
                                Form DesignerHR
                                Mobile Forms
                                Card FormsFoodOffline Forms
                                Assign FormsPhotographyMobile Forms Features
                                Translate FormsReal EstateKiosk in Mobile Forms
                                Electronic Forms
                                Drag & drop form builder

                                Notification Emails for FormsAlternativesSecurity & Compliance
                                Holiday FormsGoogle Forms alternative GDPR
                                Form to PDFJotform alternativeHIPAA Forms
                                Email FormsFormstack alternativeEncrypted Forms

                                Wufoo alternativeSecure Forms

                                TypeformWCAG


                                    All-in-one knowledge management and training platform for your employees and customers.

                                              Create. Review. Publish.

                                              Write, edit, collaborate on, and publish documents to different content management platforms.

                                              Get Started Now




                                                                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.




                                                                    Manage your brands on social media


                                                                      • Desk Community Learning Series


                                                                      • Digest


                                                                      • Functions


                                                                      • Meetups


                                                                      • Kbase


                                                                      • Resources


                                                                      • Glossary


                                                                      • Desk Marketplace


                                                                      • MVP Corner


                                                                      • Word of the Day


                                                                      • Ask the Experts


                                                                        Zoho Sheet Resources

                                                                         

                                                                            Zoho Forms Resources


                                                                              Secure your business
                                                                              communication with Zoho Mail


                                                                              Mail on the move with
                                                                              Zoho Mail mobile application

                                                                                Stay on top of your schedule
                                                                                at all times


                                                                                Carry your calendar with you
                                                                                Anytime, anywhere




                                                                                      Zoho Sign Resources

                                                                                        Sign, Paperless!

                                                                                        Sign and send business documents on the go!

                                                                                        Get Started Now




                                                                                                Zoho TeamInbox Resources





                                                                                                          Zoho DataPrep Demo

                                                                                                          Get a personalized demo or POC

                                                                                                          REGISTER NOW


                                                                                                            Design. Discuss. Deliver.

                                                                                                            Create visually engaging stories with Zoho Show.

                                                                                                            Get Started Now








                                                                                                                                • Related Articles

                                                                                                                                • How to merge and store documents in Zoho Writer

                                                                                                                                  Ask AI to explain this article: ChatGPT | Claude | Perplexity 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 ...
                                                                                                                                • How mail merge template works in Zoho CRM

                                                                                                                                  Overview During CRM integration, when a user selects or opens any record and initiates a merge operation, a temporary document is generated from the chosen template to facilitate the merge operation with the record's data. It's crucial to note that ...
                                                                                                                                • How to sort data in repeat blocks in merge templates

                                                                                                                                  Ask AI to explain this: ChatGPT | Perplexity | Claude Overview You can organize your repeat table data by sorting it using specific merge fields. For example, to list employees by department, and then by their date of joining within each department, ...
                                                                                                                                • How to generate labels with Zoho CRM data using mail merge

                                                                                                                                  Navigate to Settings from CRM Home. Under customization, click Templates > Mail Merge > New Template. Select a module. Assign a name to the template and pick a folder for the template to be saved and click Create, and select Blank. Insert a table and ...
                                                                                                                                • Configure workflow in Zoho Books with Writer's mail merge

                                                                                                                                  Overview Use Zoho Writer with Zoho Books to create branded PDFs and automate document generation from your Books data. You can either use the Zoho Writer Templates extension in Zoho Books for one‑click document generation, or configure ...
                                                                                                                                  Wherever you are is as good as
                                                                                                                                  your workplace

                                                                                                                                    Resources

                                                                                                                                    Videos

                                                                                                                                    Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                    eBooks

                                                                                                                                    Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                    Webinars

                                                                                                                                    Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                    CRM Tips

                                                                                                                                    Make the most of Zoho CRM with these useful tips.



                                                                                                                                      Zoho Show Resources