Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingest
/
sms
/
v1
/
template
/
send
Send SMS Template
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingest/sms/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>",
  "route": "<string>",
  "sender_id": "<string>",
  "template_name": "<string>",
  "template_id": "<string>",
  "variables": {},
  "is_flash": true,
  "post_back_url": "<string>",
  "post_back_data": "<string>"
}
'
{
  "success": true,
  "message": "SMS template sent successfully"
}

​
Description

This endpoint allows you to send an SMS using a predefined template. Templates can include variables that are replaced with actual values when the SMS is sent. Either template_name or template_id must be provided to identify the template.

​
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 phone number of the recipient in international format (e.g., “919876543210”).
​
route
string
required
The SMS route to use for sending. Supported routes: promotional, transactional, otp.
​
sender_id
string
required
The sender ID to display on the recipient’s phone.
​
template_name
string
The name of the SMS template to use. Either template_name or template_id is required.
​
template_id
string
The ID of the SMS template to use. Either template_name or template_id is required.
​
variables
object
Key-value pairs for template variables. Keys should match the variable names in the template, and values will replace the placeholders.
​
is_flash
boolean
Whether to send as a flash SMS. Flash SMS appears directly on the screen without saving. Default: false
​
post_back_url
string
Optional URL to receive post-back notifications about the SMS status.
​
post_back_data
string
Optional data to include in post-back notifications.

​
Response

​
success
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
Success or error response message.
{
  "success": true,
  "message": "SMS template sent successfully"
}