Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingest
/
email
/
v1
/
template
/
send
Send Email Template
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingest/email/v1/template/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "recipient": "<string>",
  "template_name": "<string>",
  "variables": {},
  "from_email": "<string>",
  "from_name": "<string>",
  "subject": "<string>",
  "pre_header": "<string>",
  "reply_to_email": "<string>",
  "reply_to_name": "<string>",
  "attachments": [
    {}
  ],
  "track_opens": true,
  "track_clicks": true,
  "post_back_url": "<string>",
  "post_back_data": "<string>"
}
'
{
  "success": true,
  "message": "Email request queued successfully",
  "request_id": "f8df74d1-11fa-4485-b164-b9a65358f4fc"
}

​
Description

This endpoint allows you to send an email using a predefined template. Templates can include variables that are replaced with actual values when the email is sent.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Body

​
recipient
string
required
The email address of the recipient.
​
template_name
string
required
The name of the email template to use.
​
variables
object
Key-value pairs for template variables. Keys should match the variable names in the template, and values will replace the placeholders.
​
from_email
string
The email address of the sender. If not provided, the default sender email will be used.
​
from_name
string
The display name of the sender.
​
subject
string
The subject line of the email. If not provided, the template’s default subject will be used.
​
pre_header
string
Optional pre-header text that appears in the email preview.
​
reply_to_email
string
The email address where replies should be sent.
​
reply_to_name
string
The display name for the reply-to address.
​
attachments
array
Array of attachment URLs to include with the email.
​
track_opens
boolean
Whether to track email opens. Default: false
​
track_clicks
boolean
Whether to track link clicks in the email. Default: false
​
post_back_url
string
(Optional) To receive post-back notifications about the sent message as it is delivered or failed. When a message status changes (delivered, failed, etc.), a notification will be sent to this URL. See Postback Notifications for the payload format and field descriptions.
​
post_back_data
string
(Optional) The data that will be sent back on the post_back_url with the notification. This can be used as an identifier for the sent message if the client wants to track or correlate messages with their own system. See Postback Notifications for how it appears in the notification.

​
Response

​
success
boolean
Indicates whether the request was successful. true if the request was accepted and queued, false otherwise.
​
message
string
Success message when the request succeeded, or error message when it failed.
​
request_id
string
Present only when success is true. Unique identifier for this request; use it for tracking and for correlating with postback notifications.
{
  "success": true,
  "message": "Email request queued successfully",
  "request_id": "f8df74d1-11fa-4485-b164-b9a65358f4fc"
}