SendTransactionalEmail

SendTransactionalEmail function sends transactional email messages to recipients.

There are two type of content to send transactional emails.

Payload-1 (use content)
In this method, the client sends the content and recipients.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.

For multi language send, the multiLangContent property should be used.


Payload-2 (use template)
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.

For multi language send, a template id created as multi language should be selected.


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.

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

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

** You cannot use multiLangContent and content properties at the same time.

Recipients language can be used as a parameter for sending with multi language content if recipient language is given, this property used as a user language otherwise contact language is used.

reply to
If the reply to property is empty, fromId used as a replyTo. Content specific replyTo information can be used for each content in sendings with multilanguage or base replyTo property which is defined under which is defined under root property, can be used for all contents inside of the multilanguage contents.


Idempotency Support: This endpoint supports idempotency via the optional traceId parameter. For more information, see Rest API Idempotency.

Body Params
attachments
array of objects

The attachments can be added using this object.

attachments
content
object

The content to be used.

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

current
object

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

multiLangContent
object

This field, used to send multi language.

string

This field is the email address should be shown in the reply section on the email sending.

reporting
object

Open and Click reporting options are setup from this object.

send
object
required

This object keeps To, Cc, Bcc addresses.

tags
array of strings

Tags given to the transactional email.

Maximum number of assigned tags is 5.

tags
string

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

GetTransactionalVmtaList gives the list of available transactional vmta list.

Headers
string
required
Defaults to {$$.env.access_token}
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Not-authorized. Please re-login.

429

Too Many Requests

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
TooManyRequest