Merge and Email

This API is used to merge and send the merged documents via email. The merged documents can be set as inline (sent in the body of email) or sent as an attachment in the email. 

1. Inline

2. Attachment

Note:

  • To use this API, an OAuth token should be generated with the following scopes; ZohoWriter.documentEditor.ALL and ZohoWriter.merge.ALL
  • To use this API for Zoho CRM, People and Recruit templates you need to add the following scopes and include the id in the merge_data

CRM: ZohoCRM.settings.emails.ALL 

People: zohopeople.automation.ALL 

Sample merge data: merge_data = {data: [{"name": "Amelia", "email": "amelia@zylker.com", "id": "1234567789"}]}

  • Check out the prerequisites needed to make the Merge and Email APIs work, here.

  • To use the 'from address alias' of Zoho Mail service as 'from address' for this API, you need to include VirtualOffice.settings.ALL scope as well.

  • This API is subject to throttle limits. For details on the applicable rate limits, please refer to this help link.

  • You can also send the merged documents via email using the deluge task, followed by the parameters zoho.writer.v2.mergeAndSend(.....)

For People Templates, we have the following limitations;

ParametersLimits
SubjectAllowed characters = 300
ContentAllowed characters = 100000
AttachmentMaximum attachments allowed = 12
Email addresses
Maximum email addresses allowed = 10 each in To, CC and BCC categories