Schemas

Download schema

MessageStatus

string · enum

Enum values:

pending

queued

suppressed

processed

delivered

opened

clicked

soft_bounced

SendMailRequest

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

object

Custom headers to include in the email.

Example: {"X-Custom-Header":"custom-value","X-Campaign-ID":"12345"}

object

Metadata to track with the email (not added as email headers).

Example: {"user_id":"123","campaign_id":"welcome-2025"}

tag

string | null

Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).

Example: welcome-email

settings

object | null

Per-email settings that override the selected route settings for this email only.

Example: {"track_opens":false,"track_clicks":true}

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]

SendBatchMailRequest

object[] · minItems: 1

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

headers

string[]

Custom headers to include in the email.

Example: {"X-Custom-Header":"custom-value","X-Campaign-ID":"12345"}

metadata

string[]

Metadata to track with the email (not added as email headers).

Example: {"user_id":"123","campaign_id":"welcome-2025"}

tag

string | null

Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).

Example: welcome-email

settings

object | null

Per-email settings that override the selected route settings for this email only.

Example: {"track_opens":false,"track_clicks":true}

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]

SendMailRequest

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

object

Custom headers to include in the email.

Example: {"X-Custom-Header":"custom-value","X-Campaign-ID":"12345"}

object

Metadata to track with the email (not added as email headers).

Example: {"user_id":"123","campaign_id":"welcome-2025"}

tag

string | null

Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).

Example: welcome-email

settings

object | null

Per-email settings that override the selected route settings for this email only.

Example: {"track_opens":false,"track_clicks":true}

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]

SendBatchMailRequest

object[] · minItems: 1

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

headers

string[]

Custom headers to include in the email.

Example: {"X-Custom-Header":"custom-value","X-Campaign-ID":"12345"}

metadata

string[]

Metadata to track with the email (not added as email headers).

Example: {"user_id":"123","campaign_id":"welcome-2025"}

tag

string | null

Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).

Example: welcome-email

settings

object | null

Per-email settings that override the selected route settings for this email only.

Example: {"track_opens":false,"track_clicks":true}

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]