Developer Guide

SendEmail

post
http://mmpeapi.dengage.com/transactional/sendEmail

SendEmail API sends already-personalized outbound Html content to recipients. Please use SendTemplate API to instanciate a template. SendEmail API does not use templates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Important Note Regarding Attachments

Please note that the total size of attachments should not exceed 1MB. Attachments exceeding this size limit will not be delivered.

Body Params

This API receives already-personalized HTML content from the client with required parameters and relays the content to recipients. This function does not use a template. Please use SendTemplate API to personalize and relay a template to recipients.

  1. In case the content contains any customization variable than the developer needs to be made aware since these parameters have to be sent with the params variable in the request. The format of this parameter is JSON. JSON message may change from content to content. This parameter is set to null if the content does not have any personalization variables.

  2. sendId is used to group messages with a Group ID. The Group ID may be used to get reports of all corresponding messages under a batch report. For example, Send ID may be the Campaign ID in your system so that a consolidated report for a campaign can be obtained from the reporting interface with a single click to related report function. This parameter can be set to null.

  3. if saveContent is set to true, the whole message content (created by combining the content with the params plus attachments) per request is saved in the database. Note that the size in the database rapidly grows if this parameter is set to true.

  4. if saveParams is set to true, all request by the client is saved in the database.

IMPORTANT NOTE-1:
After customization of the content, if some parameters are left "not customized" with params the calling client set, the message relay is rejected! For example, there is {{name}} parameter on the content and params parameter doesn't have name parameter, the message is rejected to be relayed by the API!

IMPORTANT NOTE-2:
For email messages, AttachmentList property is used to add attachments to the relayed message.

string
required

Content is a complete HTML formatted message for the channel.

string
required

Subject is the email message subject.

integer

Vmta Pool to relay the email message. Please ask the system administrator to have this vmta pool id.

Vmta Pools define the path in mta-core engine group to relay messages. This parameter is optional. If set to null or 0, the system will use your account's default pool for emails.

integer

Specifies the account on the system for users which have an access to multiple accounts.

This parameter is optional. If set to null, the system will use api user's default account.

integer

From Address Id. Please ask the system administrator to have this from id or use /configuration/sendParams method to retrieve all related id's.

From Id define the from name and from address to send messages. This parameter is optional. If set to null or 0, the system will use your account's default from address.

integer

Reply Address Id. Please ask the system administrator to have this from id or use /configuration/sendParams method to retrieve all related id's.

Reply Id define the reply address to send messages. This parameter is optional. If set to null or 0, the system will use your account's default reply address.

string

The unique message id which will be assigned to the message. If set to null, the system creates and assigns a unique message id to the message.

It may be set to null or may not set at all. Under this condition, the system will assign a unique message id to the message. Please check return message in order to get unique message id. This message id is used to get reports for this specific message.

rcptToList
array of strings
required

RcptTo list - The email addresses which will receive email messages in To field.

It may be set to null.

rcptToList*
ccList
array of strings

Carbon Copy recipient list (cc) - The email addresses which will receive email messages in Cc field.

It may be set to null.

ccList
bccList
array of strings

Blind Copy recipient list (bcc) - The email addresses which will receive email messages in Bcc field.

It may be set to null.

bccList
string

Send id is used to group messages under a tag so that reporting with a single id is possible. Typical example of send id is a campaign id, bulk id in your campaign system.

It may be set to null

string

The parameter json having parameters to personalize the messages.

If your html content have a parameters, this json is used to send parameters for replace.

For example, the content may contain {{name}} parameter name is the parameter. While customizing this content, the params may have

{"name":"John"}

JSON so that name parameter will be replaced with John.

**It can be set to null

boolean

if set to "true", the params sent by request is saved into the database in order to keep the parameters to customize the content.

It can be set to null or may not set at all.

boolean

if set to "true", the whole personalized content is saved into the database.

Please note that this is a huge content saved in the database so the disk size must be arranged accordingly.

It can be set to null.

attachmentList
array of objects

Attachment objects.

attachmentList
Headers
string

The access token

Responses

401

Please login again to get new token.

403

Please login again to get new token.

Updated 10 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?