Email API v.2 - Request Fields Summary

Email Plus JSON contains a number of properties that can be set by you per message.

Request fields

Path

Type

Description

from

Object

The sender information of the email
Address must be one of the Authorized senders. Required

replyTo

Object

Information regarding the reply to address

to[]

Array of Email Address Objects

The standard email recipient addresses along with (optional) name information.
Must contain at least one recipient. Required

cc[]

Array of Email Address Objects

The carbon copy email recipient addresses along with (optional) name information.
Optional

bcc[]

Array of Email Address Objects

The blind carbon copy email recipient addresses along with (optional) name information.
Optional

customHeaders[]

Array of customHeader Objects

List of custom headers.
No more than 10 elements.
Optional

subject

String

The subject of the email.
Size must be less than 145 characters.
Skipping this property is strongly discouraged

content

Object

The actual content of the email message.
Contains two properties html containing the HTML content and text for text only UTF-8 content.

attachments[]

Array of attachmentObject

Attachments of the email message. The attachmentObject has the following format:{"content":"base64 encoded data", "type":"mime/type", "filename":"attachment file name you wish"}

scheduledDate

String

The date and time to send the email message(s) . Given date must be {offset} {unit} after now

ttl

Number

Time-to-live value in minutes, after this period, if the message is not delivered it will be considered as failed.
Must be a positive number of minutes between 30 and 4320 (72H).

maxAttempts

Number

The maximum send retries to apply on transitional failures.

footer

Object

The footer to apply on the message, containing two properties html and text to be applied on the actual content of the message

callback

Object

Callback related information regarding the execution. If provided, at least one type of callback information must exist.

label

String

Custom label for the email message(s). A string up to 80 characters long that categorizes the message.

dsn

Object

Delivery status notifications (DSN) options

Response fields

Path

Type

Description

trackingId

String

The tracking id of the transactional email execution

Table 1. HTTP 400

errorCode

type

Explanation

000000

InvalidDomain

The provided sender domain is invalid. It needs to get added and verified to be used.

000001

InvalidSender

The provided sender is invalid. It needs to get added and verified to be used.

000002

UnverifiedSender

The provided sender is unverified. It needs to get verified to be used.

000004

NoActiveSubscription

No active transactional email subscription exists

000005

InsufficientResourcesException

In case resources are not enough to send email (depleted or limited)