POST
/
v1
/
transactional
/
custom
curl --request POST \
  --url https://api.flywheel.cx/v1/transactional/custom \
  --header 'Auth-Type: <api-key>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": {
    "from": "notifications@yourdomain.com",
    "to": "user@example.com",
    "subject": "Welcome to our platform!",
    "html": "<h1>Welcome!</h1><p>Thank you for signing up for our platform.</p>"
  }
}'
{
  "success": true,
  "email_id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

Enter your API key obtained from the Flywheel dashboard (without 'Bearer ' prefix)

​
Auth-Type
string
header
default:api
required

Authentication type header. Must be set to 'api' for all API requests.

Body

application/json
​
params
object
required

Response

Email sent successfully

​
success
boolean

Whether the email was sent successfully

Example:

true

​
email_id
string<uuid>

Unique UUID identifier for the sent email, can be used for tracking delivery status

Example:

"123e4567-e89b-12d3-a456-426614174000"