Schemas

Download schema

MessageStatus

string · enum

Enum values:

scheduled

pending

queued

quarantined

suppressed

processed

delivered

opened

SendMailRequest

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

scheduled_at

string · maxLength: 255

ISO 8601 or English delivery time. A time without a timezone uses UTC.

Example: tomorrow at 9am

object

Custom headers to include in the email. To preserve a submitted RFC Message-ID, include both Message-ID and X-LM-Preserve-Message-ID with a string value of true or 1. Header names and control values are case-insensitive; false or 0 retains replacement.

Example: {"Message-ID":"<ticket-123@example.com>","X-LM-Preserve-Message-ID":"true"}

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

object[] · maxItems: 20

Reusable exact-match tags. Names must be unique and are case-sensitive.

Example: [{"name":"campaign","value":"welcome-v2"},{"name":"environment","value":"production"}]

settings

object | null

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

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

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[]

scheduled_at

string · maxLength: 255

object

Example: {"Message-ID":"<ticket-123@example.com>","X-LM-Preserve-Message-ID":"true"}

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

object[] · maxItems: 20

Reusable exact-match tags. Names must be unique and are case-sensitive.

Example: [{"name":"campaign","value":"welcome-v2"},{"name":"environment","value":"production"}]

settings

object | null

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

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

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]

TlsPolicy

string · enum

Enum values:

opportunistic

enforced

SendMailRequest

from

string · required

to

string[] · minItems: 1 · required

subject

string · maxLength: 998 · required

route

string

cc

string[]

bcc

string[]

reply_to

string[]

scheduled_at

string · maxLength: 255

ISO 8601 or English delivery time. A time without a timezone uses UTC.

Example: tomorrow at 9am

object

Example: {"Message-ID":"<ticket-123@example.com>","X-LM-Preserve-Message-ID":"true"}

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

object[] · maxItems: 20

Reusable exact-match tags. Names must be unique and are case-sensitive.

Example: [{"name":"campaign","value":"welcome-v2"},{"name":"environment","value":"production"}]

settings

object | null

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

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

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[]

scheduled_at

string · maxLength: 255

object

Example: {"Message-ID":"<ticket-123@example.com>","X-LM-Preserve-Message-ID":"true"}

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

object[] · maxItems: 20

Reusable exact-match tags. Names must be unique and are case-sensitive.

Example: [{"name":"campaign","value":"welcome-v2"},{"name":"environment","value":"production"}]

settings

object | null

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

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

html

string | null · minLength: 3

text

string | null · minLength: 3

object[]