How to manage merge field IDs and subform fields when using Zoho Writer's merge APIs
1. Why are merge field values not merged or replaced correctly during the merge operation?
2. How to obtain merge field IDs and use them with Merge APIs?
- Open the merge template and navigate to the Automate tab in the left panel.
- Click on Manage Fields in the merge panel, then select Show Field ID to retrieve the exact field IDs.
- For subform field IDs:
- Navigate to the Subform tab.
- Expand the subform and click Show Field ID to view and copy the field IDs.
Main Field IDs
3. Why aren’t subform or multi-line field values merged correctly in PDF templates?
4. How to pass subform or related list fields for Merge APIs in Writer?
- In the Writer merge template, insert a subform table or repeat region using the Repeat button under Advanced Merge Fields.
- Retrieve the merge field IDs for the subform or related list fields as described earlier (in Question#2), and map the values in the input JSON data using the format below.
{
"data": [
{
"customer_name": "Amelia",
"customer_address": "13th Street, USA",
"customer_email_address": "amelia@zylker.com",
"customer_phone_number": "9876543210",
"invoice_number": "123456",
"items": [
{
"items.item_code": "123",
"items.item_name": "Fastrack Revoltt FS1",
"items.item_description": "Specifications",
"items.item_replacement": "Yes"
},
{
"items.item_code": "1278",
"items.item_name": "Samsung Refridgerator",
"items.item_description": "Specifications",
"items.item_replacement": "Yes"
}
]
}
]
}
items and repairs, use the following approach:- Fetch data using APIs like getRecords for integrations (e.g., CRM, Recruit, People).
- Map the values for both main and subform fields as shown above.
dataMap = Map();
recordsData.put("customer_name": "Amelia");
recordsData.put("customer_address": "13th Street USA");
recordsData.put("customer_email_address": "amelia@zylker.com");
recordsData.put("customer_phone_number": "9876543210");
recordsData.put("invoice_number": "123456");
//Subform1
itemsList = list();
itemMap = Map();
itemmap.put("items.item_code": "123");
itemmap.put("items.item_name": "Fastrack Revoltt FS1");
itemmap.put( "items.item_description": "<p><b>Specifications</b></p>");
itemmap.put("items.item_replacement": "Yes");
itemsList.add(itemmap);
//subform2
repairList = list();
repairDetails = Map();
repairDetails.put("Repairs.Service_code", "R100");
repairDetails.put("Repairs.Description", "Faulty belt");
repairDetails.put("Repairs.Quantity", "5");
repairDetails.put("Repairs.Price", 10000);
repairList.add(repairDetails);
recordsData.put("items", itemsList);
recordsData.put("Repairs", repairList)
mergedata = Map();
mergedata.put("merge_data", {"data": recordsData});
//pass this merge data to respective merge api like mentioned below
zoho.writer.mergeAndSend("eb4kob4cf65bb6d074af7a7de21e561119eb9", "pdf", "amelia@zylker.com", mergedata, "writer_name");
For a complete guide on passing values for all merge field types, refer to the Comprehensive Merge Field Documentation.
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:
Create. Review. Publish.
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.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
How to merge subform fields and image field via Zoho Writer's Merge APIs?
Overview Zoho Writer's Merge API enables the dynamic population of documents using data from Zoho CRM. This includes merging not only standard fields but also related list (subform) fields and image fields. This guide outlines the steps required to ...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 Writer templates using Zoho Flow
We're working on a Zoho Flow-Writer integration to help you pick template documents from Writer, place merge fields on them and merge it with data from Zoho Services. Find below steps to merge Writer Documents and with Zoho Creator Form fields. Steps ...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 ...How to control field rendering through merge field type settings
Overview Zoho Writer's merge fields type make the data source value appear as formatted text, numbers, dates, checkboxes, images, hyperlinks, maps, chart or watermark. This flexibility allows users to design automated proposals, invoices, and reports ...