Skip to content

POST /emails​

POST
/emails

Send a transactional email. The referenced Template's current content is
rendered with the supplied variables at send time. Respects the workspace
Suppression list (a suppressed destination returns status suppressed) but
not marketing Unsubscribe — transactional mail carries no sending source.

Supply an Idempotency-Key to make retries safe: a repeated key replays the
original result without sending a second email, and a key whose first request
is still in flight returns 409.

Authorizations​

BearerAuth
Type
HTTP (Bearer)

Parameters​

Header Parameters

Idempotency-Key

Client-supplied key that makes a retried send idempotent (Stripe-style)

Type
string

Request Body​

application/json
JSON
{
  
"templateId": "string",
  
"destination": "string",
  
"variables": {
  
  
"additionalProperties": null
  
}
}

Responses​

The request has been accepted for processing, but processing has not yet completed.

application/json
JSON
{
  
"id": "string",
  
"status": "string",
  
"destination": "string"
}

Playground​

Server
Authorization
Headers
Body

Samples​

Powered by VitePress OpenAPI