Skip to main content

Do Merge Record

Last updated 30/03/2026

Overview​

The Do Merge Record event is a server-side event that executes for each record while a mail merge is running. It executes to allow attaching documents to that specific record during the mail merge.

How it Works​

When a mail merge is running:

  1. The Do Merge Record event executes for each individual record in the merge list.
  2. Any document attachments configured for that record execute during this event.
  3. Once the event completes for a record, the mail merge proceeds to the next record, and the Do Merge Record event executes again.

Use Cases​

  • Attaching PDFs or other documents to each record
  • Ensuring each record receives its required attachments

Example Scenario​

A user or a job runs a mail merge for 50 recipients:

  1. The Do Run event executes to start the mail merge.
  2. The Do Merge Record event executes for the first recipient, attaching the specified document.
  3. The Do Merge Record event executes for the second recipient, attaching the same or another document.
  4. This continues until the Do Merge Record event has executed for all recipients, completing the mail merge attachments.