How to use the record_id parameter in Zoho Writer's merge templates

How to use the record_id parameter in Zoho Writer's merge templates

The record_id parameter in Zoho Writer's merge templates allows you to easily fetch the values of the desired fields based on the record_id value. With this new parameter, you do not have to manually map every field used in the template in your Deluge code.

Prerequisites for using the record_id parameter   

Ensure these conditions are met before using the record_id parameter:
  1. You should have connected your merge template to a data source.
  2. You should have the necessary permissions to fetch records from the data source.
  3. You must have sufficient automation credits to generate documents. Learn more about credits and pricing.

Zoho apps supported by the Merge APIs  

At the moment, the Merge APIs integrate with these Zoho apps to fetch the relevant records using the record_id:
  1. Zoho CRM
  2. Zoho Creator
  3. Bigin
  4. Zoho Recruit

Sample Code

Here’s an example of how to use the record_id parameter in a Deluge code to merge a specific record from Zoho CRM into a Writer template:
  1. document_id = "4tx4ie20882e93a3b40a58a613213b5491b99";
  2. recordId = "154845000004785001";
  3. outputsettings = Map();
  4. outputsettings.put("doc_name","Student Grade PDF");
  5. outputsettings.put("folder_id","mt3vx64b53cadf1dxxxxxxxxxxx");
  6. outputsettings.put("output_format","pdf");
  7. param = Map();
  8. param.put("record_id",recordId);
  9. param.put("output_settings",outputsettings);
  10. response = invokeurl
  11. [
  12. url :"https://zohoapis.com/writer/api/v2/documents/1mg03e345d3ecbe4241958089f6cd9a55421d/merge/store"
  13. type :POST
  14. parameters:param
  15. connection:"writercrm"
  16. ];
  17. info response;
This Deluge code fetches the data for the given record_id and merges it into the document template to dynamically generate a personalized document.

Benefits of the record_id parameter

  1. The required records and their fields are fetched and mapped automatically using the record ID
  2. The process is accurate and error-free
  3. Automation saves time and effort
Refer this forum post to learn how record_id parameter simplifies Deluge code.