v1

latestOpenAPI 3.0.02026-07-1733092.8 KB

post/v1/emails/batch

Headers

Idempotency-Keystring

Pass the optional Idempotency-Key header to make the request safe to retry. The key can be up to 256 characters. The server stores the canonical request body and behaves as follows:

  • Same key + same request body → returns the original emailId with 200 OK without re-sending.
  • Same key + different request body → returns 409 Conflict with code: NOT_UNIQUE so you can detect the mismatch.
  • Same key while another request is still being processed → returns 409 Conflict; retry after a short delay or once the first request completes.

Entries expire after 24 hours. Use a unique key per logical send (for example, an order or signup ID).

Request body

fromstring required
subjectstring

Optional when templateId is provided

templateIdstring

ID of a template from the dashboard

variablesobject
textstring nullable
htmlstring nullable
headersobject

Custom headers to included with the emails

scheduledAtstring date-time
inReplyToIdstring nullable

Response

List of successfully created email IDs