Emails

Send a transactional email

Sends an email from any address on one of your verified domains — no mailbox needs to exist for the sender. Recipients on your suppression list (previous hard bounces and complaints) are dropped automatically; if none survive, the call fails with 422 and nothing is sent. Set an Idempotency-Key header to make retries safe: a repeated key returns the original result instead of sending twice. Counts against the monthly send limit. Requires scope mail:send. Delivery events (delivered/bounced/complained) can be pushed to your server as they happen — configure webhooks in the dashboard under Transactional → API.

post/emails

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/emails
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique string (up to 256 chars). Two requests with the same key send at most one email; the second gets the first's response back.

Request body

fromstring required

Sender: any address on one of your verified domains, bare or as "Name <address>". No mailbox needs to exist. With no name, the From name is the name of the mailbox at that address, else the domain default.

fromNamestring

From display name; wins over a name written into from

subjectstring

Required unless templateAlias is given

htmlstring

HTML body. With templateAlias, this markup fills the template's API-content block instead — your HTML renders inside the designed template.

textstring

Plain-text body

replyTostring

Reply-To address

templateAliasstring

Alias of a stored transactional template; supplies subject and body. Combine with html to render your own markup inside the template's API-content block.

variablesobject

Values for the template's {{variables}}. Strict: a missing variable fails with 422 and nothing is sent.

Example request

{
  "from": "Acme Receipts <receipts@acme.com>",
  "subject": "Your receipt",
  "templateAlias": "receipt",
  "attachments": [
    {
      "filename": "invoice.pdf",
      "contentType": "application/pdf"
    }
  ]
}

Response

Email accepted for delivery

successboolean

Example response

{
  "success": true,
  "data": {
    "from": "receipts@acme.com"
  }
}

Changes

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