How to merge subform fields and image field with Zoho Writer's Merge APIs in Zoho CRM
How to merge subform fields via Merge API's in Zoho Writer
1. Create a Merge template in Writer with related (RL) fields
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» |
2. Sample code to get the RL fields info
document_id -> It can be derived from the document open url: https://{{domain}}/writer/open/eb4kob4cf65bb6d074af****************
{
"merge": [
{
"id": "First_Name",
"groupname": "Contacts",
"display_name": "First Name",
"type": "text"
},
{
"id": "Email",
"groupname": "Contacts",
"display_name": "Email",
"type": "email"
},
{
"id": "Invoices",
"display_name": "Invoices",
"type": "subform",
"fields": [
{
"id": "Invoices.Owner",
"groupname": "Invoices",
"display_name": "Invoice Owner",
"type": "text"
},
{
"id": "Invoices.Invoice_Number",
"groupname": "Invoices",
"display_name": "Invoice Number",
"type": "number"
},
{
"id": "Invoices.Created_By",
"groupname": "Invoices",
"display_name": "Created By",
"type": "text"
},
{
"id": "Invoices.Due_Date",
"groupname": "Invoices",
"display_name": "Due Date",
"type": "text"
}
]
},
{
"id": "Products",
"display_name": "Products",
"type": "subform",
"fields": [
{
"id": "Products.Product_Code",
"groupname": "Products",
"display_name": "Product Code",
"type": "text"
},
{
"id": "Products.Product_Description",
"groupname": "Products",
"display_name": "Product Description",
"type": "text"
},
{
"id": "Products.Item_Quantity",
"groupname": "Products",
"display_name": "Item Quantity",
"type": "number"
},
{
"id": "Products.Item_Price",
"groupname": "Products",
"display_name": "Item Price",
"type": "number"
}
]
}
],
"sign": {},
"fill": {}
}
3. Sample code to map the RL fields (via deluge)
invoicesRecords = zoho.crm.getRecordById("Invoices", invoiceId);
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;
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
}
]
}
]
How to pass image fields values to Zoho CRM's mail merge via 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:
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
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
How to use Zoho WorkDrive images into Writer merge fields?
Zoho Writer only accepts Public URL for the image fields in Mail merge. If the images are stored in Zoho WorkDrive, you can create a downloadable link and use it as an input value for the image field. This can be done in the following three ways; a) ...Working with Fields
Supported field types Supported field types Description Possible Values in the data source Rendered as Notes Plain Text The value of the field is placed as a string in the document. “test” “test” You can select the field in the document and apply the ...Mail merge support for Zoho CRM modules
What are the CRM modules that are supported for mail merge with Zoho Writer? With the Zoho Writer Add-on, you can create mail merge documents using CRM data from the following modules: Leads Accounts Contacts Deals Quotes Sales Orders Invoices ...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 filter records on subform related lists in mail merge?
You can do this by adding filters in subforms. 1. Open your Writer document and add your subform fields. 2. Now right click on the subform field and choose Apply Filter to Repeat Records. 3. Now add the filters of your choice and hit Filter. 4. The ...