Create a template
curl --request POST \
--url https://truecaller.udchowdhury.me/v1/templates \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Order shipped",
"category": "transactional",
"body": "Hi {{name}}, your order *{{order_id}}* has shipped.",
"variable_defaults": {
"name": "there"
},
"media": {
"url": "https://example.com/box.jpg",
"mime_type": "image/jpeg"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
]
}
'import requests
url = "https://truecaller.udchowdhury.me/v1/templates"
payload = {
"name": "Order shipped",
"category": "transactional",
"body": "Hi {{name}}, your order *{{order_id}}* has shipped.",
"variable_defaults": { "name": "there" },
"media": {
"url": "https://example.com/box.jpg",
"mime_type": "image/jpeg"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Order shipped',
category: 'transactional',
body: JSON.stringify('Hi {{name}}, your order *{{order_id}}* has shipped.'),
variable_defaults: {name: 'there'},
media: {url: 'https://example.com/box.jpg', mime_type: 'image/jpeg'},
buttons: [{type: 'link', text: 'Track order', url: 'https://example.com/t/{{order_id}}'}]
})
};
fetch('https://truecaller.udchowdhury.me/v1/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://truecaller.udchowdhury.me/v1/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Order shipped',
'category' => 'transactional',
'body' => 'Hi {{name}}, your order *{{order_id}}* has shipped.',
'variable_defaults' => [
'name' => 'there'
],
'media' => [
'url' => 'https://example.com/box.jpg',
'mime_type' => 'image/jpeg'
],
'buttons' => [
[
'type' => 'link',
'text' => 'Track order',
'url' => 'https://example.com/t/{{order_id}}'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://truecaller.udchowdhury.me/v1/templates"
payload := strings.NewReader("{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://truecaller.udchowdhury.me/v1/templates")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://truecaller.udchowdhury.me/v1/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"category": "promotional",
"body": "<string>",
"variable_defaults": {},
"media": {
"url": "<string>",
"mime_type": "image/jpeg",
"file_name": "<string>"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": [
"name",
"order_id"
],
"status": "draft",
"reject_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "invalid body",
"details": [
{
"path": [
"to"
],
"message": "Required"
}
]
}{
"error": "<string>",
"details": [
{}
]
}Templates
Create a template
Create a reusable message with variables, an optional attachment and up to 3 buttons.
POST
/
v1
/
templates
Create a template
curl --request POST \
--url https://truecaller.udchowdhury.me/v1/templates \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Order shipped",
"category": "transactional",
"body": "Hi {{name}}, your order *{{order_id}}* has shipped.",
"variable_defaults": {
"name": "there"
},
"media": {
"url": "https://example.com/box.jpg",
"mime_type": "image/jpeg"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
]
}
'import requests
url = "https://truecaller.udchowdhury.me/v1/templates"
payload = {
"name": "Order shipped",
"category": "transactional",
"body": "Hi {{name}}, your order *{{order_id}}* has shipped.",
"variable_defaults": { "name": "there" },
"media": {
"url": "https://example.com/box.jpg",
"mime_type": "image/jpeg"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Order shipped',
category: 'transactional',
body: JSON.stringify('Hi {{name}}, your order *{{order_id}}* has shipped.'),
variable_defaults: {name: 'there'},
media: {url: 'https://example.com/box.jpg', mime_type: 'image/jpeg'},
buttons: [{type: 'link', text: 'Track order', url: 'https://example.com/t/{{order_id}}'}]
})
};
fetch('https://truecaller.udchowdhury.me/v1/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://truecaller.udchowdhury.me/v1/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Order shipped',
'category' => 'transactional',
'body' => 'Hi {{name}}, your order *{{order_id}}* has shipped.',
'variable_defaults' => [
'name' => 'there'
],
'media' => [
'url' => 'https://example.com/box.jpg',
'mime_type' => 'image/jpeg'
],
'buttons' => [
[
'type' => 'link',
'text' => 'Track order',
'url' => 'https://example.com/t/{{order_id}}'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://truecaller.udchowdhury.me/v1/templates"
payload := strings.NewReader("{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://truecaller.udchowdhury.me/v1/templates")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://truecaller.udchowdhury.me/v1/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Order shipped\",\n \"category\": \"transactional\",\n \"body\": \"Hi {{name}}, your order *{{order_id}}* has shipped.\",\n \"variable_defaults\": {\n \"name\": \"there\"\n },\n \"media\": {\n \"url\": \"https://example.com/box.jpg\",\n \"mime_type\": \"image/jpeg\"\n },\n \"buttons\": [\n {\n \"type\": \"link\",\n \"text\": \"Track order\",\n \"url\": \"https://example.com/t/{{order_id}}\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"category": "promotional",
"body": "<string>",
"variable_defaults": {},
"media": {
"url": "<string>",
"mime_type": "image/jpeg",
"file_name": "<string>"
},
"buttons": [
{
"type": "link",
"text": "Track order",
"url": "https://example.com/t/{{order_id}}"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": [
"name",
"order_id"
],
"status": "draft",
"reject_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "invalid body",
"details": [
{
"path": [
"to"
],
"message": "Required"
}
]
}{
"error": "<string>",
"details": [
{}
]
}A template is saved as a
draft. Submit it before
you send it.
- Variables: write
{{name}}anywhere in the body, in button labels or in button URLs. In a campaign each one is filled from the contact list column with the same name. Setvariable_defaultsfor contacts whose cell is empty, e.g.{ "name": "there" }. - Styling: Truecaller renders
*bold*,_italic_,~strikethrough~,`monospace`and[label](https://…)links. - Media and buttons: see Rich messages.
Authorizations
Workspace API key from Developers → API keys. It starts with tc_live_.
Body
application/json
Maximum string length:
100Available options:
promotional, transactional, service Message text with {{variable}} placeholders and Truecaller text styling.
Maximum string length:
1000Used when a contact's value is empty.
Show child attributes
Show child attributes
One attachment. Upload with Upload media, or give any public https URL.
Show child attributes
Show child attributes
Maximum array length:
3Up to 3 per message. Labels and URLs can use {{variables}}.
- Link button
- Quick reply
Show child attributes
Show child attributes
Response
Created, as a draft.
Maximum string length:
100Available options:
promotional, transactional, service Message text with {{variable}} placeholders and Truecaller text styling.
Maximum string length:
1000Used when a contact's value is empty.
Show child attributes
Show child attributes
One attachment. Upload with Upload media, or give any public https URL.
Show child attributes
Show child attributes
Maximum array length:
3Up to 3 per message. Labels and URLs can use {{variables}}.
- Link button
- Quick reply
Show child attributes
Show child attributes
Example:
["name", "order_id"]
Available options:
draft, submitted, approved, rejected Was this page helpful?