Email

Send a templated email.

Renders template with data and sends it to to. Requires the email:send scope.

post/v1/email/send/tx

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/email/send/tx
  • Auth: HTTP bearer

Request body

templatestring required

Name of the template to render.

tostring required

Recipient address.

dataobject nullable

Variables substituted into the template.

Example request

{
  "template": "order_confirmation",
  "to": "user@example.com"
}

Response

Email accepted for delivery

idstring required

Message id, used to correlate later delivery events.

statusstring required

Delivery state at the time of the response.

tostring required

Recipient the message was accepted for.

templatestring nullable

Template used, echoed back on the templated send.

Example response

{
  "id": "01J8Z4T2QK9V3H",
  "status": "queued",
  "to": "user@example.com"
}

Changes

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