Overview
Retrieve the list of variables required by a WhatsApp message template. These variables must be supplied when sending template messages or configuring WhatsApp AI Agents that use the selected template.Prerequisites
- Bearer Token authentication
- Connected WhatsApp Business phone number
- Valid WhatsApp Template ID
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the connected WhatsApp Business phone number.
string
required
Unique identifier of the WhatsApp message template.
Response
boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating the template variables were retrieved successfully.
object
Contains information about the selected template and its variables.
string
Unique identifier of the WhatsApp template.
string
Name of the WhatsApp template.
array
List of variables required by the template.
string
Variable name that should be populated before sending the template.
string
Expected data type of the variable.
Error Handling
The returned variables correspond to the placeholders defined in the WhatsApp Business template. Every required variable should be populated before the template is sent.
Related endpoints:
GET /api/whatsapp/get-templates/{phoneNumberId}— Retrieve all templates for a WhatsApp number.GET /api/whatsapp/get-all-templates— Retrieve all templates available in the workspace.

