Body Parameters

from
string
required

Sender email address.

To include a friendly name, use the format "Your Name <sender@domain.com>".

to
string | string[]
required

Recipient email address. For multiple addresses, send as an array of strings. Max 50.

subject
string
required

Email subject.

bcc
string | string[]

Bcc recipient email address. For multiple addresses, send as an array of strings.

cc
string | string[]

Cc recipient email address. For multiple addresses, send as an array of strings.

scheduled_at
string

Schedule email to be sent later. The date should be in language natural (e.g.: in 1 min) or ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z).

See examples

reply_to
string | string[]

Reply-to email address. For multiple addresses, send as an array of strings.

html
string

The HTML version of the message.

text
string

The plain text version of the message.

react
React.ReactNode

The React component used to write the message. Only available in the Node.js SDK.

headers
object

Custom headers to add to the email.

attachments
array

Filename and content of attachments (max 40mb per email).

See examples

content
buffer | string

Content of an attached file, passed as a buffer or base64 string.

filename
string

Name of attached file.

path
string

Path where the attachment file is hosted

content_type
string

Content type for the attachment, if not set will be derived from the filename property

tags
array

Custom data passed in key/value pairs.

See examples.

name
string
required

The name of the email tag.

It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

It can contain no more than 256 characters.

value
string
required

The value of the email tag.

It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

It can contain no more than 256 characters.