Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Messages

Send Email message

The method is used for sending an Email message to a contact. A new contact is created if no contact with such email address exists.<br><br><strong>⚠️ Not recommended for OTP passwords.</strong> This method requires the full email HTML in the request body. Because of the content volume, such requests are not logged reliably, which makes delivery troubleshooting difficult.<br>Use the <a href="https://docs.esputnik.com/reference/sendextendedpreparedmessage-1">Send prepared message</a> method instead: the caller only passes substitution variables, the template is stored on our side, so the message is sent faster and all requests are logged correctly.

post/api/v1/message/email

Request body

fromstring required

Sender address (enter one of the valid sender addresses). Address format: ""name" <test@mail.com>"

subjectstring required

Message subject

htmlTextstring required

Message HTML code

plainTextstring

Version of the message in plain text

ampHtmlTextstring

Message AMP HTML code

emailsstring[] required

The list of recipients

tagsstring[]

The list of tags assigned to the message

externalRequestIdstring

External request ID. It is the same for all the recipients

skipPersonalisationboolean

Skip the application of personalization to the message

subscriptionsKeysstring[]

Array of subscription category keys added to the message

trackUrlsboolean

The parameter determines whether to track links in the message or not. The default value is ‘true’

Example request

{
  "from": "john.smith@address.com",
  "subject": "Seasonal sale",
  "plainText": "Explore our new collection"
}