Get template with contact data placeholders resolved
curl --request POST \
--url https://your-instance.example.com/api/user/sms-templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phoneNumber": "+14155550133",
"selectedUser": {
"channelType": "sms",
"messengerId": "+14155550133"
}
}
'import requests
url = "https://your-instance.example.com/api/user/sms-templates/{templateId}"
payload = {
"phoneNumber": "+14155550133",
"selectedUser": {
"channelType": "sms",
"messengerId": "+14155550133"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phoneNumber: '+14155550133',
selectedUser: {channelType: 'sms', messengerId: '+14155550133'}
})
};
fetch('https://your-instance.example.com/api/user/sms-templates/{templateId}', 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://your-instance.example.com/api/user/sms-templates/{templateId}",
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([
'phoneNumber' => '+14155550133',
'selectedUser' => [
'channelType' => 'sms',
'messengerId' => '+14155550133'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your-instance.example.com/api/user/sms-templates/{templateId}"
payload := strings.NewReader("{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/user/sms-templates/{templateId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/user/sms-templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Hi Alex! Confirming your tour for Friday at 2:00pm.",
"type": "sms",
"category": "tours"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}User
Get template with contact data placeholders resolved
Returns the template body with placeholders ({{firstName}}, {{lastName}}, etc.) resolved against the supplied contact phone/channel. Used by the composer to preview the final message.
POST
/
api
/
user
/
sms-templates
/
{templateId}
Get template with contact data placeholders resolved
curl --request POST \
--url https://your-instance.example.com/api/user/sms-templates/{templateId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phoneNumber": "+14155550133",
"selectedUser": {
"channelType": "sms",
"messengerId": "+14155550133"
}
}
'import requests
url = "https://your-instance.example.com/api/user/sms-templates/{templateId}"
payload = {
"phoneNumber": "+14155550133",
"selectedUser": {
"channelType": "sms",
"messengerId": "+14155550133"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phoneNumber: '+14155550133',
selectedUser: {channelType: 'sms', messengerId: '+14155550133'}
})
};
fetch('https://your-instance.example.com/api/user/sms-templates/{templateId}', 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://your-instance.example.com/api/user/sms-templates/{templateId}",
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([
'phoneNumber' => '+14155550133',
'selectedUser' => [
'channelType' => 'sms',
'messengerId' => '+14155550133'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your-instance.example.com/api/user/sms-templates/{templateId}"
payload := strings.NewReader("{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/user/sms-templates/{templateId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/user/sms-templates/{templateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneNumber\": \"+14155550133\",\n \"selectedUser\": {\n \"channelType\": \"sms\",\n \"messengerId\": \"+14155550133\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Hi Alex! Confirming your tour for Friday at 2:00pm.",
"type": "sms",
"category": "tours"
}{
"error": "User not found",
"details": "No user with id 64ee9a8b1e7f2a0011223399"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Resolved template returned
⌘I