We recommend that you use this version as the previous version will no longer be updated for new enhancements.
How to submit
You can submit emails by invoking the Enginemailer Email Service at https://api.enginemailer.com/RESTAPI/V2/Submission/SendEmail
Please use the method name: SendEmail.
Please note that our REST API only accepts JSON object as a parameter list. To ensure proper authentication, you should include only one authentication parameter (APIKey) within the header.
Templates
We allow users to send emails with or without templates. To create a template, please visit here.
Sample
Below is an example of the Request JSON object to deliver the email.
{
"CampaignName":"Marketing Campaign for Customer Group A",
"ToEmail":"put_recipient _email_here@gmail.com",
"Subject":"Remember us?",
"SenderEmail":"your_email@domainRegistered.com",
"SubmittedContent":"Hi there, remember us?",
"SenderName":"Your name",
"SubstitutionTags":[
{
"Key":"Key0",
"Value":"Value0"
},
{
"Key":"Key1",
"Value":"Value1"
},
{
"Key":"Key2",
"Value":"Value2"
}
],
"Attachments":[
{
"Filename":"Test1.pdf",
"Content":"SG93IHRvIGRlYnVnIFNRTCBTdG9yZWQgUHJvY2VkdXJlDQoNCjEuIExvY2FsIG9ubHkgLSBBenVyZSAoTm8pDQoyLiBQdXQgYnJlYWtwb2ludCBhdCBFWEVDIHN0YXRlbWVudA0KMy4gQ2xpY2sgRGVidWcNCjQuIE9uY2UgaGl0IGJyZWFrcG9pbnQsIHByZXNzIEYxMSB0byBzdGVwIGludG8gdGhlIHN0b3JlZCBwcm9jZWR1cmUu"
},
{
"Filename":"Test2.pdf",
"Content":"SG93IHRvIGRlYnVnIFNRTCBTdG9yZWQgUHJvY2VkdXJlDQoNCjEuIExvY2FsIG9ubHkgLSBBenVyZSAoTm8pDQoyLiBQdXQgYnJlYWtwb2ludCBhdCBFWEVDIHN0YXRlbWVudA0KMy4gQ2xpY2sgRGVidWcNCjQuIE9uY2UgaGl0IGJyZWFrcG9pbnQsIHByZXNzIEYxMSB0byBzdGVwIGludG8gdGhlIHN0b3JlZCBwcm9jZWR1cmUu"
}
],
"CCEmails":[
"put_cc_email_here_1@gmail.com",
"put_cc_email_here_2@gmail.com"
],
"BCCEmails":[
"put_bcc_email_here_1@gmail.com",
"put_bcc_email_here_2@gmail.com"
]
}|
Parameter name (Case-sensitive) |
Description |
Nullable? |
|
CampaignName |
Name of the mailing campaign. |
Yes |
|
ToEmail |
Intended recipient email address. |
No |
|
Subject |
The subject of the email. |
Yes |
|
SenderEmail |
Email address from the sender. (The email domain will validate against the verified sending domain) |
No |
|
SenderName |
Name of the sender. |
Yes |
|
SubmittedContent |
Email content of the email. |
Yes |
|
TemplateId |
Template ID of the template which created on the Enginemailer system. If you use TemplateId, Subject and Sender Name will follow your template. No need to specify again. Sender Email must be specified in the JSON Object and must be the same with the one in template. |
Yes |
|
SubstitutionTags |
A list of dynamic variables with values to be substituted within the template content(Multiple). Please note that the value inside cannot have the following characters: { } [ ] |
Yes |
|
Attachments |
A list of files to be attached to the email. The maximum total attachment size is 5MB. The “Filename” must have extension (.docx, .txt, etc) and “Content” is the Base64 encoded content of the attachment. |
Yes |
|
CCEmails |
A list of emails. The maximum number of CC emails allowed is 10. |
Yes |
|
BCCEmails |
A list of emails. The maximum number of BCC emails allowed is 3. |
Yes |