Skip to main content
POST
/
template
/
send
Send a template-based email
curl --request POST \
  --url https://emails.platform.arb.inc/template/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expires": "2025-08-11T15:04:05Z",
  "to": [
    {
      "address": "[email protected]",
      "name": "Bob Lee"
    }
  ],
  "template": "welcome-email",
  "variables": {
    "username": "johndoe",
    "activation_link": "https://example.com/activate/abc123"
  },
  "idempotency_key": "user-signup-12345"
}
'
{
  "message": "email queued for delivery"
}

Authorizations

​
Authorization
string
header
required

access token

Body

application/json
​
expires
string<date-time>
required

Expiration time for the email. Must be in the future and within 7 days.

Example:

"2025-08-11T15:04:05Z"

​
to
object[]
required

At least one recipient is required.

Minimum array length: 1
​
template
string
required

Required template identifier to use for the email.

Example:

"welcome-email"

​
variables
object
required

Required key-value pairs of variables to be used in the template.

Example:
{
  "username": "johndoe",
  "activation_link": "https://example.com/activate/abc123"
}
​
idempotency_key
string
required

Required unique key to ensure idempotent email sending. Combined with requestor identity (user:org or service ID) to prevent duplicate sends.

Example:

"user-signup-12345"

Response

Email successfully queued for delivery.

​
message
string

Confirmation message that the email was queued.

Example:

"email queued for delivery"