Skip to main content
POST
Send bulk email (batch send to multiple recipients)

Authorizations

Authorization
string
header
required

JWT token obtained from /api/auth/token endpoint. Token is verified using JWKS and must include a valid user identifier.

Body

application/json
recipients
object[]
required

List of recipients (1-10,000)

Required array length: 1 - 10000 elements
Example:
subject
string
required

Email subject line

Required string length: 1 - 200
Example:

"Important Update"

html
string
required

HTML email content (max 500KB)

Required string length: 1 - 500000
Example:

"<html><body><h1>Update</h1><p>Important information...</p></body></html>"

text
string

Plain text fallback (optional)

Maximum string length: 100000
Example:

"Update: Important information..."

name
string

Optional description/name for this bulk send

Maximum string length: 200
Example:

"Monthly Newsletter - November 2024"

metadata
object

Additional metadata

Example:

Response

Bulk send queued successfully

success
boolean
required
bulkSendId
string
required
status
string
required
totalRecipients
number
required