post

/transactional/email

SendTransactionalEmail function sends transactional email messages to recipients.

There are 2 different methods to send transactional emails.

Method-1

In this method, the client sends the content and recipients. More than one recipient is possible in To, Cc, Bcc fields. The system returns uuid-type transactionalIds per recipient and uuid-type groupId for all.

These transactional ids are used to get the report per recipient whereas the groupId response field is used to get the report of all recipient at once.

Inserting attachments are possible with attachments object. Attached files must be base64 encoded.

Method-2

This method is used to send transactional email messages using an existing template in the system. The only difference from Method-1 is templateId field is used to select the template from the system. This templateId can be created both using API (CreateEmailContent) or through GUI.

Method-3 You can send with a sender name other than the sender name defined in the account.You can send by changing the field before the @ sign of the sender address defined in the account.You can examine sample requests.

Method-4 You can analyze your own report by adding xHeaders to your post.You can examine sample requests.

Request Parameters

1 Header

Request Body

10 Examples
Schema
object
content
object

The content to be used.

*Please note that either templateId or html/subject/fromNameId fields must be used.

required
vmtaId
string

The uuid of the vmta. If not set default transactional vmta is used.

GetTransactionalVmtaList gives the list of available transactional vmta list.

send
object

This object keeps To, Cc, Bcc addresses. Addresses should be separated with ‘,’ character.

required
current
object

If templateId field is used to send to a templateId, this object is used to send parameters to this template.

reporting
object

Open and Click reporting options are setup from this object.

attachments
array[object]

The attachments can be added using this object.

tags
array[string]

Tags given to the transactional email.

Maximum number of assigned tags is 5.

Responses

The messages has been sent. Please keep transacionalId(s) and groupId to use in reporting later.

1 Example
Schema
object
transactionId
string
code
integer
message
string
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
access_token