Send one email to many recipients
send_batchSend the same email to many recipients in ONE call. Use this instead of calling send_message in a loop whenever two or more people get a similar message (an announcement, invitations, a follow-up with each person's name). Write {{field}} in the subject, text or html and give each recipient its fields, e.g. {{first_name}}; a field a recipient lacks renders empty. Faivelo queues the batch, sends it at the plan's pace and tracks every recipient; the reply comes back at once with a batch id and each recipient as "queued" (poll get_batch_status for sent, delivered, bounced). Every recipient counts against the monthly send allowance like a single send. The whole batch is accepted or refused: over the plan's per-call cap or the remaining allowance, nothing is queued and the error says the cap (usage shows it as batch.recipientsPerCall). idempotencyKey is required and makes a retry safe: the same key returns the original batch instead of sending again.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | Yes | The sending mailbox, "updates@yourdomain.com" or "Acme Updates <updates@yourdomain.com>" | |
| html | No | HTML body; may contain {{field}} tokens (values are HTML-escaped) | |
| text | No | Plain-text body; may contain {{field}} tokens | |
| labels | No | Free-form tags kept on the batch and echoed in its status and webhook events | |
| replyTo | No | Reply-To address, when replies should go somewhere other than the sending mailbox | |
| subject | Yes | Subject line; may contain {{field}} tokens | |
| fromName | No | From name for this batch only; overrides a name in from and the mailbox's own name | |
| recipients | Yes | One entry per recipient. Duplicate addresses are sent once. | |
| idempotencyKey | Yes | Required. A value unique to this batch (e.g. "launch-notice-2026-10"); repeating it returns the original batch instead of sending again |