Email

Send a raw email.

Sends an HTML email without a stored template. Requires the email:send scope.

post/v1/email/send/raw

Request

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

Request body

tostring required

Recipient address.

subjectstring required

Subject line.

htmlstring required

HTML body.

Example request

{
  "to": "user@example.com",
  "subject": "Your receipt",
  "html": "<p>Thanks for your order.</p>"
}

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.