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.

post/api/v1/message/email

Request

  • Base URL: https://yespo.io (the document declares no server; this is the origin it was published from)
  • URL: https://yespo.io/api/v1/message/email
  • Auth: HTTP basic

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.