Sign in

v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Email

Send an email

post/message-handler/send-email

Request body

tostring required

The recipient email address

fromstring required

The sender email address

templatestring required

The email template ID

contextobject

Key-value pairs to populate the email template. The keys must be the names of the variables in the template used for the email.

subjectstring required

The subject line

accountstring

Account ID. This is required to define which localized template should be used. If account ID is not specified, the organization's default localization is used.

Example request

{
  "to": "customer@fanhero.com",
  "from": "no-reply@fanhero.com",
  "template": "CONFIRMATION",
  "context": {
    "recipient_name": "John Doe"
  },
  "subject": "Account Created",
  "account": "61bdd71f41e298e5a8bfa804"
}

Response

Successful response

acceptedstring[] required

A list of email addresses that have accepted the email message

rejectedstring[] required

A list of email addresses that rejected the email message

envelopeTimenumber required

The time to process the email envelope

messageTimenumber required

The time to process the email message

messageSizenumber required

The email message size

responsestring required

Response

messageIdstring required

The unique identifier assigned to the email message

Example response

{
  "accepted": [
    "user@server.com"
  ],
  "rejected": [
    "user@server.com"
  ],
  "envelopeTime": 234,
  "messageTime": 234,
  "messageSize": 1024,
  "response": "250 Ok: queued as 3g_zvTr-RZmfnMot2SnubQ",
  "envelope": {
    "from": "sender@server.com",
    "to": [
      "recipient@server.com"
    ]
  },
  "messageId": "<b4716ae2-0d11-b4ae-0207-62781b11ce17@server.com>"
}
All 212 operations