lumail.emails.batch

SDK 2.1.0 · API v2 · POST /api/v2/emails/batch

MethodPOST

/api/v2/emails/batch

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.emails.batch(
  [
    { from: "[email protected]", to: "[email protected]", subject: "A", html: "<p>A</p>" },
    { from: "[email protected]", to: "[email protected]", subject: "B", html: "<p>B</p>" },
  ],
  { idempotencyKey: "welcome-batch-1" },
);
if (error) {
  throw error;
}
console.log(data.data.map((email) => email.id));

Response Examples

{ "data": [{ "id": "eml_..." }, { "id": "eml_..." }] }

[email protected] · lumail.emails

emails.batch(emails: SendEmailParams[], options?: { idempotencyKey?: string }): Promise<LumailResult<{ data: { id: string }[] }>>

Up to 100 sends. Each item matches emails.send. HTTP body is the JSON array.

Body Parameters

Name	Type	Description
`emails`	`SendEmailParams[]`	Required. First argument. Array of send payloads. Max 100. Each item: `from`, `to`, `subject`, and exactly one of `html`, `tiptap`, or `markdown`. Also accepts `text`, `reply_to`, `cc`, `bcc`, `headers`, `tags`, `preview`.

Options

Name	Type	Description
`idempotencyKey`	string	Second-argument option. Mapped to the `Idempotency-Key` header. The server suffixes `:index` per item.

Response Fields

Field	Type	Description
`data`	`{ id: string }[]`	Queued email ids, same order as the request.

data is { data: [{ id }] }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.emails.send Nextlumail.emails.get