Ariadocs

Schemas

Reusable models from components.schemas.

fromstringrequired

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

tostring | string[]required

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

subjectstringrequired

Email subject.

bccstring | string[]

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

ccstring | string[]

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

reply_tostring | string[]

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

htmlstring

The HTML version of the message.

textstring

The plain text version of the message.

templateobject
headersobject

Custom headers to add to the email.

scheduled_atstring

Schedule email to be sent later. The date should be in ISO 8601 format.

attachmentsAttachment[]
tagsTag[]
topic_idstring

The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic's default subscription is opt_in.

contentstring<binary>

Content of an attached file.

filenamestring

Name of attached file.

pathstring

Path where the attachment file is hosted

content_typestring

Optional content type for the attachment, if not set it will be derived from the filename property

content_idstring

Content ID for embedding inline images using cid references (e.g., cid:image001).

Tagobject
namestring

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.

valuestring

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.

idstringrequired

The id of the published email template.

variablesobject

Template variables object with key/value pairs.

idstring

The ID of the sent email.

Emailobject
objectstring

The type of object.

idstring

The ID of the email.

message_idstring

The Message-ID header value of the email.

tostring[]
fromstring

The email address of the sender.

created_atstring

The date and time the email was created.

subjectstring

The subject line of the email.

htmlstring

The HTML body of the email.

textstring

The plain text body of the email.

bccstring[]

The email addresses of the blind carbon copy recipients.

ccstring[]

The email addresses of the carbon copy recipients.

reply_tostring[]

The email addresses to which replies should be sent.

last_eventstring

The status of the email.

One of: "bounced""canceled""clicked""complained""delivered""delivery_delayed""failed""opened""queued""scheduled""sent""suppressed"
objectstring

Type of the response object.

has_moreboolean

Indicates if there are more results available.

dataEmail[]

Array containing email information.