Skip to main content
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT
 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace

Join us for the biggest low-code event of the year. Register now!

x

Choose where you’d like to start

Merge and Store V2 in Zoho Writer

Description

The zoho.writer.v2.mergeAndStore task merges the document and stores it in a specific location in Zoho WorkDrive. This task is based on the Zoho Writer Merge and Store v2 API.

Note: Applicable to all services except Zoho Creator. 
Creator users can use the Writer Merge and Store V2 Rest API with the invoke URL method.

Syntax

<response> = zoho.writer.v2.mergeAndStore(<document_id>, <merge_detail>, <output_settings>, <optional_settings>, <connection>)

where:

ParamsData typeDescription
<response>KEY-VALUEThe response returned by Zoho Writer. It represents the merged document's details such as the merge data, along with the status of the merge.
<document_id>TEXT

The ID of the document which needs to be merged and stored in Zoho WorkDrive.

The document ID can be obtained from the URL of the document which needs to be merged and stored in WorkDrive.

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

<merge_detail>KEY-VALUE Specify how your input for the merge will be. It can be JSON, CSV file, or a URL.
<output_settings>{
'doc_name': "<new document name>",
'folder_id': "<folder_id>" ,
'output_format': "<pdfform/pdf/docx>",
'password': "<*****>",
'overwrite_existing_file': "<true/false>",
'merge_to':"<separatedoc/singledoc>
}

Pass the values for doc_name and folder_id via this parameter as a JSON.

doc_name: The name of the merged document.

folder_id: Specify the id of the folder in which you would like to store the merged document.

output_format (optional): The format in which you would like to store the merged document. Supported formats are PDFPDFForm, and DOCX.

Note: If this key is not passed, the merged documents will be stored in Writer's format (ZDOC) by default.

password (optional): Specify a password if you would like to protect the merged document. This param is applicable only for PDF and DOCX documents.

overwrite_existing_file (optional): Use this param, if you wish to replace an existing file stored in Zoho WorkDrive with the merged document.

merge_to (optional): The type of document to be created from the merge. Supported merge types are separatedoc and singledoc.

separatedoc: If you would like to merge each record as a separate document.

singledoc: If you would like to merge all the records as a single document.

Note: By default, we will apply separatedoc as the merge type.

<optional_settings>KEY-VALUE  The optional parameters you can send to merge and store according to your preference.
<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

 

You can provide the merge_detail parameter in any one of the below formats:

KeyValueDescription
merge_dataJSONObjectPass a String value through data key as JSON Array.
merge_data_csv_contentFileProvide the required CSV content in your API request body.
merge_data_json_contentFileProvide the required JSON content in your API request body.
merge_data_csv_urlURLProvide the required CSV URL in your API request body.
merge_data_json_urlURLProvide the required JSON URL in your API request body.

option_settings parameter values:

ParameterData TypeDescription
sign_service_nameString

 

Specify a third-party signing service name to make your merged document's signing fields compatible with.

Possible values are zohosign, adobesign, and docusign. By default, the service will be zohosign.

 

test_modeBoolean (true/false)

Using this parameter, you can test the Merge APIs without consuming any credit points. The output file will contain a watermark as it is used only for testing purposes.

Test mode limit: 50 merges/day for an org.

Note: 

  • To use this API, an OAuth token should be generated with the following scopes ZohoWriter.documentEditor.ALL and ZohoWriter.merge.ALL
  • If you would like to store the documents (docx/pdf) inside a Workdrive/Docs folder, you need to include the following scopes accordingly;
    • For Workdrive - WorkDrive.Files.ALL
    • For Docs - ZohoPC.files.ALL

Example

The following script merges a document and stores it in a specific folder in Zoho WorkDrive.

document_id = "po5uobda049e029d44b13a9956f6d2cedc67b"; 
                fields = Map(); 
                fields.put("Name", "Ms.Amelia");
                fields.put("Tamil", "S");
                fields.put("English", "A");
                fields.put("Maths", "A");
                fields.put("Remark", "Good");
                data_map = Map();
                data_map.put("data", fields);
                merge_details = Map();
                merge_details.put("merge_data", data_map);
                optional_settings= Map();
                optional_settings.put("sign_service_name","zohosign");
                optional_settings.put("test_mode", "true");
                output_settings = Map();
                output_settings.put("doc_name","Student Grade");
                output_settings.put("folder_id","bsa6360a78f53f***");   //Workdrive Folder ID  //optional
                output_settings.put("output_format","pdf");    //docx|pdfform|pdf  //optional
                output_settings.put("password","*****");    //optional
                output_settings.put("overwrite_existing_file","true");  //true|false  //optional
                response = zoho.writer.v2.mergeAndStore(document_id, merge_details, output_settings, optional_settings, "writer_oauth_connection");
                info response;

Usecase

Scenario 1: Merge and store proposals

Say you're generating a proposal for a deal in CRM. Sales team generates a new proposal by merging it and saves it to a particular folder in WorkDrive.

document_id = "po5uobda049e029d4r98r84304jrj32";
                fields = Map(); 
                fields.put("ClientName", "Zylker");
                fields.put("ClientCompany", "Writer");
                fields.put("price", "10000");
                data_map = Map();
                data_map.put("data", fields);
                merge_details = Map();
                merge_details.put("merge_data", data_map);
                optional_settings= Map();
                output_settings = Map();
                output_settings.put("doc_name","SALES PROPOSAL");
                output_settings.put("folder_id","bsa6360a78f53f***");   //Workdrive Folder ID  //optional
                output_settings.put("output_format","pdf");    //docx|pdfform|pdf  //optional
                output_settings.put("password","*****");    //optional
                output_settings.put("overwrite_existing_file","true");    //true|false  //optional
                response = zoho.writer.v2.mergeAndStore(document_id, merge_details, output_settings, optional_settings, "writer_oauth_connection");
                info response;
                

Response Format

{
                    "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"
                }

Related Links

 

Get Started Now

Execute