API referenceEmails

Send an email

POST/emails

Queues one email for sending through SES in your AWS account. Accepts scheduled_at (ISO 8601 or natural language, up to 30 days ahead) and an Idempotency-Key header. The from domain must be a verified domain of the project with sending enabled. With template: { id, variables } (a published template by id or alias) the body comes from the template; html and text may then not be set, and from, subject and reply_to override the template defaults.

Authorization

apiKey
AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Header Parameters

idempotency-key?string
Length1 <= length <= 256

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/emails" \  -H "Content-Type: application/json" \  -d '{    "to": "string"  }'
{  "id": "string"}