Skip to main content
GET
/
api
/
data
/
rcs
/
v1
/
{bot_id}
/
variable-keys
Get RCS Template Variables
curl --request GET \
  --url https://api-ai.zixflow.com/api/data/rcs/v1/{bot_id}/variable-keys \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Template variables retrieved successfully",
  "data": [
    {
      "key": "customer_name",
      "type": "text"
    },
    {
      "key": "order_number",
      "type": "text"
    },
    {
      "key": "product_image",
      "type": "image"
    }
  ]
}

​
Description

This endpoint allows you to retrieve the variable keys and their types for a specific RCS template. This is useful when you need to know what variables are required or available in a template before sending a message.

​
Headers

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

​
Path Parameters

​
bot_id
string
required
The unique identifier of the RCS bot. This is the Bot ID associated with your RCS account.

​
Query Parameters

​
template_name
string
required
The name of the RCS template for which you want to retrieve variable information.

​
Response

​
success
boolean
Indicates whether the API call was successful.
​
message
string
Success or error message from the API.
​
data
array
An array of template variable objects, each containing:
​
data[].key
string
The variable key name that should be used when sending the template.
​
data[].type
string
The type of the variable (e.g., “text”, “image”, “video”, etc.).
{
  "success": true,
  "message": "Template variables retrieved successfully",
  "data": [
    {
      "key": "customer_name",
      "type": "text"
    },
    {
      "key": "order_number",
      "type": "text"
    },
    {
      "key": "product_image",
      "type": "image"
    }
  ]
}