Email - Outgoing

Send an email using a template

Request body

messageIdstring

An optional message id used to identify the message. If no message id is provided, a new message id is generated and assigned to the message. This id must be unique across all messages created on the same account. (In case a previous message has been deleted according to GDPR deletion rules setup on the specific account, the messageId is allowed to be reused) If max length is exceeded, the entire api call will fail.

sendTimestring

If set, this defines to time in the future for the message to be sent. e.g. 2001-02-30T14:50:23Z (UTC time).

trackingboolean

If true, this will add Open and Click tracking to your email. Default: true.

listUnsubscribeboolean

If true, this will add a List-Unsubscribe header to your email. If a subscriber unsubscribes using this method, an event will be created. Please note that it is your responsibility to unsubscribe the email address in your system, as we do not add the email address to an unsubscribe list in inMobile. Default: false.

anonymizeOptionsstring[]

Choose the fields that should be anonymized. You can anonymize none or all of the fields. The fields will be anonymized instantly after the email has been handled. Default: "none". Allowed values: "none", "all"

templateIdstring required

The id of the template to use.

Example request

{
  "from": {
    "emailAddress": "roy@tomlinson.com",
    "displayName": "Roy Tomlinson"
  },
  "to": [
    {
      "emailAddress": "roy@tomlinson.com",
      "displayName": "Roy Tomlinson"
    }
  ],
  "replyTo": [
    {
      "emailAddress": "roy@tomlinson.com"
    }
  ],
  "messageId": "8fe266b2-56e9-4b5f-938f-cc5e22530721",
  "sendTime": "2001-02-30T14:50:23Z",
  "attachments": [
    {
      "name": "MyFile.pdf",
      "content": "SGVsbG8gd29ybGQ="
    }
  ],
  "listUnsubscribe": true,
  "anonymizeOptions": [
    "all"
  ],
  "templateId": "ecdcb257-c1e9-4b44-8a4e-f05822372d82"
}

Response

messageIdstring

An optional message id used to identify the message. If no message id is provided, a new message id is generated and assigned to the message. This id must be unique across all messages created on the same account. (In case a previous message has been deleted according to GDPR deletion rules setup on the specific account, the messageId is allowed to be reused) If max length is exceeded, the entire api call will fail.

usedPlaceholderKeysstring[]

A list of used placeholder keys.

notUsedPlaceholderKeysstring[]

A list of not used placeholder keys.

Example response

{
  "messageId": "8fe266b2-56e9-4b5f-938f-cc5e22530721",
  "to": [
    {
      "emailAddress": "roy@tomlinson.com",
      "displayName": "Roy Tomlinson"
    }
  ],
  "usedPlaceholderKeys": [
    "{name}",
    "{lastname}"
  ],
  "notUsedPlaceholderKeys": [
    "{name}",
    "{lastname}"
  ]
}

Send an email using a template

Request

Request body

Example request

Response

Example response

Changes