Skip to main content
POST
/
v1
/
transactional_email_template
/
send
cURL
curl --request POST \
  --url https://staging.terminal3.io/v1/transactional_email_template/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "transactional_email_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 1,
  "placeholders": {}
}
'
This response has no body data.

Documentation Index

Fetch the complete documentation index at: https://docs.terminal3.io/llms.txt

Use this file to discover all available pages before exploring further.

Make sure to provide values for all your custom placeholders when sending the email. If any placeholder is missing a value, the send API will return an error. Supported system placeholders:
  • {{ sys.first_name }}: the user’s first name from their profile.
System placeholders (like {{ sys.first_name }}) are automatically filled in by the system using the user’s profile data. For example, “Hi {{ sys.first_name }}” will become “Hi John” when sent to a user named John.
Here’s an example of a JSON object with all the placeholders used in an email template. Subject: 
Welcome to {{ platform_name }}!
Body: 
Hi {{ user_name }},
Welcome to {{ platform_name }}! We're excited to have you join us.
To get started, please confirm your email by clicking the button below:
{{ confirmation_link }}
If you have any questions, feel free to reach out to our support team at {{ support_email }}.

Thanks,
The {{ platform_name }} team!
Make sure your placeholders include all the required ones when sending the email template above:
POST /v1/transactional_email_template/send
{
    "transactional_email_template_id": <UUID>,
    "user_id": <UserID>,
    "placeholders": {
        "platform_name": "Terminal 3",
        "user_name": "John",
        "confirmation_link": "https://example.com/path",
        "support_email": "support@example.com"
    }
}

Headers

​
x-api-token
string
required
​
x-api-subclient-id
string

Body

application/json
​
transactional_email_template_id
string<uuid>
required
​
user_id
number
required
Required range: x > 0
​
placeholders
object

Response