How to merge subform fields and image field via Zoho Writer's Merge APIs?
Overview
Steps
Step 1: Create a Merge Template in Zoho Writer with Related List (RL) Fields
- Open Zoho Writer and create a new merge template.
- Insert merge fields for both main module and related list (subform) fields using the field insert option.
Invoice Owner | Invoice Number | Created By | Due Date |
<<Invoices.Invoice Owner>> | <<Invoices.Invoice Number>> | << Invoices. Created By>> | <<Invoices.Due Date>> |
Product_Code | Product_Description | Item_Quantity | Item_Price |
«Products.Product_Code» |
«Products.Product_Description» |
«Products.Item_Quantity» |
«Products.Item_Price» |
Step 2: Retrieve RL Field Information via API
Replace <DOCUMENT_ID> with your actual Writer document ID.
Reference Zoho Connections for setting up the connection.
Step 3: Map RL Fields via Deluge Script
CustomerInvoice = Map();
CustomerInvoice.put("First_Name", invoicesRecords.get("Account_Name").get("name"));
CustomerInvoice.put("Email", invoicesRecords.get("Account_Name").get("id"));
invoicesList = list();
invoiceDetails = Map();
invoiceDetails.put("Invoices.Owner", invoicesRecords.get("Owner").get("name"));
invoiceDetails.put("Invoices.Invoice_Number", invoicesRecords.get("Invoice_Number"));
invoiceDetails.put("Invoices.Created_By", invoicesRecords.get("Created_By").get("name"));
invoiceDetails.put("Invoices.Due_Date", invoicesRecords.get("Due_Date"));
invoicesList.add(invoiceDetails);
productList = list();
productDetails = Map();
productDetails.put("Products.Product_Code", invoicesRecords.get("Product_Code"));
productDetails.put("Products.Product_Description", invoicesRecords.get("Product_Description"));
productDetails.put("Products.Item_Quantity", invoicesRecords.get("Item_Quantity"));
productDetails.put("Products.Item_Price", invoicesRecords.get("Item_Price"));
productList.add(productDetails);
CustomerInvoice.put("Invoices", invoicesList);
CustomerInvoice.put("Products", productList)
mergedata = Map();
mergedata.put("merge_data", {"data": CustomerInvoice});
mergedata.put("subject", "Invoice Details");
//optional
mergedata.put("message", "Please find your invoice attached.");
info mergedata;
Step 4: Sample JSON data with RL fields (via APIs)
"data": [
{
"First_Name": "Amelia",
"Email": "amelia@zylker.com",
"Invoices": [
{
"Invoices.Owner": "John",
"Invoices.Invoice_Number": 1279,
"Invoices.Created_By": "Amelia",
"Invoices.Due_Date": "07/10/2020"
}
]
"Products": [
{
"Products.Product_Code": "A123",
"Products.Product_Description": "Mobile Cases",
"Products.Item_Quantity": 2,
"Products.Item_Price": 1000
}
]
}
]
Step 5: Pass Image Field Values in Merge API
- Invoke Get Record API (version 5 and above) and use the Preview Image ID [Preview_Id__s] from the CRM response.
- Construct the image URL manually using the below pattern:
Additional Notes
- Always use the /fields API to dynamically retrieve field names for accurate mapping.
- Ensure that merge field names in the Writer template exactly match the JSON keys used in your API or Deluge script.
- For all image fields, construct the image URL using the
__attachment_previewendpoint:https://{zohoapi_domain}/crm/v2.1/__attachment_preview/{Preview_Id__s} - The CRM API only provides image Preview IDs, not full URLs — construction is mandatory.
- Use the correct API versions (
v5for CRM,v2.1for attachment preview). - If using Deluge:
- Ensure connection is set up.
- JSON mapping must match the Writer template structure.
- The Writer Document ID can be found in the URL in this format:
/writer/open/<document_id>
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 and send document via email in Zoho Writer
Overview The Merge and Send via Email option in Zoho Writer lets you generate personalized documents for each record in your data source and automatically send them via email. Each recipient gets a customized document as an attachment or inline ...How to setup image type merge field in Zoho Writer
Overview The Image Field Merge feature in Zoho Writer lets you dynamically insert images (like profile photos, product images, logos, or scanned documents) into templates during a mail merge. You can map image fields from your data source—such as ...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 use Zoho WorkDrive images in Zoho Writer's merge fields
Overview When performing a mail merge in Zoho Writer, image fields must be provided with a public URL to properly display the image. If your images are stored in Zoho WorkDrive, you can generate a public download URL and use it for your image fields. ...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 ...