Skip to main content
GET
Get Truecaller Template Variables

Description

Lists the placeholders the caller must send in variables for a template send. Placeholders that start with brand. are filled by Zixflow and are left out. Keys are returned in order of first use: message text, then media URL, then link URLs. Each type is text. data is an array. A template with no caller variables returns "data": [].

Headers

string
required
Your API key for authentication. The workspace on the key must match x-workspace-id.
string
required
Workspace id that owns the API key.

Path Parameters

string
required
Bot (channel settings) id. A value that is not a 24-character hex id returns 404.

Query Parameters

string
required
Template name, for example order_shipped.

Request Example

Response

boolean
true when the template was found.
string
Request processed successfully on success.
array
Caller variables, in order of first use. Empty when the template has no caller variables.
string
Placeholder name. Letters, digits, _, and .. Send this as a key in variables.
string
Always text.
400 messages are bot_id is required or template_name is required. 404 is returned for an unknown name, the wrong workspace, or a bot_id that is not a 24-character hex id.