Emails

Send a transactional email

post/emails

Request

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

Headers

Idempotency-Keystring

Optional idempotency key (max 256 chars). Retries with the same key and identical body return the original response. Same key with a different body, or a concurrent in-flight request, returns 409. A 502 or 503 where the mail server did not take the message releases the key, so a retry with it sends the email. A 504 keeps the key, because the email may still be delivered.

Request body

subjectstring

Required unless using template (optional override when sending with a template).

htmlstring
htmlBodystring

Alias for html

html_bodystring

Alias for html

textstring
textBodystring

Alias for text

text_bodystring

Alias for text

plain_bodystring

Alias for text

tagstring

Optional delivery tag override.

headersobject

Custom headers after server-side safety filtering.

scheduled_atstring date-time

Schedule delivery for a future ISO 8601 timestamp. Returns status scheduled.

scheduledAtstring date-time

Alias for scheduled_at.

unsubscribeboolean

Opt in to managed unsubscribe for this send. Injects RFC 8058 List-Unsubscribe headers and replaces {{unsubscribe_url}} in subject/html/text. When sending with a template, inherits the template's unsubscribe_enabled setting unless overridden here.

category'transactional' | 'product' | 'newsletter'

Optional send-level category override. Defaults to the template's category when sending with a template, otherwise transactional. Product and newsletter categories support category-scoped opt-out and auto-enable managed unsubscribe.

Example request

{
  "attachments": [
    {
      "content_type": "application/pdf"
    }
  ]
}

Response

Email accepted for delivery

idstring required

Public message ID (msg_…)

statusstring required

Example response

{
  "status": "sent"
}

Changes

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