Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Pass your Gorillaa Mail API key as a Bearer token.

Example: Authorization: Bearer grl_live_xxxxxxxxxxxx

Keys prefixed grl_test_ operate in test mode with reduced limits.

Headers

X-Idempotency-Key
string

Unique idempotency key (max 255 chars). Duplicate requests within 24h return the original response.

Maximum string length: 255

Body

application/json
from
required

An email address — either a plain string or an object with name

to
(string<email> | object)[]
required

Primary recipients (1–50)

Required array length: 1 - 50 elements

An email address — either a plain string or an object with name

subject
string
required
Required string length: 1 - 998
cc
(string<email> | object)[]
Maximum array length: 50

An email address — either a plain string or an object with name

bcc
(string<email> | object)[]
Maximum array length: 50

An email address — either a plain string or an object with name

replyTo

An email address — either a plain string or an object with name

html
string

HTML body (max 5MB). Either html or text is required.

Maximum string length: 5242880
text
string

Plain text body (max 1MB). Either html or text is required.

Maximum string length: 1048576
headers
object

Custom email headers

tags
string[]

Tags for categorization (max 10)

Maximum array length: 10
Maximum string length: 100
scheduledAt
string<date-time>

Schedule delivery for a future time (must be ≥1 minute in the future)

idempotencyKey
string

Client-generated idempotency key

Maximum string length: 255
attachments
object[]

File attachments (max 10)

Maximum array length: 10
metadata
object

Arbitrary metadata stored with the email

Response

Email accepted for delivery

data
object
required