---
isPublished: true
knowledgeIndex: false
hidden: true
noindex: true
template: "page.peb"
title: "Batch Emailer Action Flow Reference"
description: "Submit email delivery for the generated documents in an existing Batch Run."
contentType: "reference"
audience: "admin,developer"
---

# Batch Emailer Action

Submit email delivery for the generated documents in an existing Batch Run.
The namespaced Apex action name is `rooms__BatchEmailAction`.

## Transaction summary

| Effect | Behavior |
| --- | --- |
| API callout | No HTTP callout in the action step. |
| Record writes | Queues a Salesforce batch job. Later email processing can write DialogueOne Event records and publish status events. |
| Platform event | The email job can publish document-send events. These do not confirm delivery to a recipient. |
| Background work | Yes. Success is submission, not completion. |
| Email | The batch sends configured document emails and a completion notification. |

This action shares its Flow label with [BatchAttachmentEmailer](/content/build/flows/BatchAttachmentEmailer.md). This entry point accepts **Batch Job ID**, rather than **Batch Run ID**. Both operate on an existing Batch Run and its generated Attachments.

## Inputs

Required describes the Flow input setting. Additional configuration rules can still require a value.

| API name | Flow label | Required | Default or guidance |
| --- | --- | --- | --- |
| `batchID` | Batch Job ID | Yes | Select the existing Batch Run record. |
| `batchSize` | Batch Size | No | Defaults to `10`. Use a valid size for Salesforce batch email processing. |

## Outputs

| API name | Flow label | Meaning |
| --- | --- | --- |
| `batchID` | Batch Job ID | Exposed output. Retain the input Batch Run ID; the action does not populate this field. |
| `success` | Success | Whether definition lookup and submission succeeded. |
| `message` | Message | Lookup or validation error details. |

## Configure the Flow

1. Select the existing Batch Run with a valid generated-document delivery list.
2. Confirm its recipients, email template and sender settings.
3. Set Batch Size and invoke the action once.
4. Store Success and Message, then monitor the submitted job and DialogueOne Events.

Confirm the Flow user's Apex action access and access to the records or Files used by this operation. Review the configured Salesforce API connection user's access when the action makes an API request. For native Salesforce email, also confirm email access, permitted sender configuration and any required activity access.

## Troubleshooting

**Missing batchID.** Supply the Batch Run record ID.

**The action faults during submission.** Connect the Fault path. A valid job submission is not proof that all emails were sent.

**No email arrives.** Check job status, recipient records, Attachment ownership and DialogueOne Events before retrying.

See the [Flow action catalog](/content/build/flows/index.md) for related actions and transaction guidance. Confirm that the action and input fields are available in the installed package.
