Emails

Send an email

post/emails

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/emails
  • Auth: HTTP bearer

Headers

Idempotency-Keystring nullable

Required for deployment-token requests. Reusing a key with the same payload returns the original delivery; reusing it with a different payload returns 409.

Request body

bccstring[] nullable

BCC recipients

ccstring[] nullable

CC recipients

fromstring required

Sender email address (domain will be auto-extracted for lookup)

from_namestring nullable

Sender display name

headersobject nullable

Custom headers

htmlstring nullable

HTML body content

reply_tostring nullable

Reply-to address

subjectstring required

Email subject

tagsstring[] nullable

Tags for categorization

textstring nullable

Plain text body content

tostring[] required

Recipient email addresses

track_clicksboolean nullable

Enable click tracking (link rewriting). Defaults to false.

track_opensboolean nullable

Enable open tracking (tracking pixel injection). Defaults to false.

Example request

{
  "from": "hello@updates.example.com",
  "from_name": "My App",
  "html": "<h1>Hello World</h1>",
  "subject": "Welcome to our platform!",
  "tags": [
    "welcome",
    "onboarding"
  ],
  "text": "Hello World",
  "to": [
    "user@example.com"
  ]
}

Response

Email sent successfully

idstring required

Email ID

provider_message_idstring nullable

Provider message ID

statusstring required

Email status

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "sent"
}

Changes

No recorded changes to this operation across all 54 revisions of this API.