WhatsApp Templates
Update WhatsApp template
Updates a draft WhatsApp template.
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
whatsapp_templates
/
{id}
Update WhatsApp template
curl --request PATCH \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
]
}
],
"variable_mappings": {}
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}"
payload = {
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [{ "components": "<array>" }]
}
],
"variable_mappings": {}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
language: 'en_US',
whatsapp_channel_id: 123,
components: [
{
text: '<string>',
buttons: [{text: '<string>', url: '<string>', phone_number: '<string>'}],
cards: [{components: '<array>'}]
}
],
variable_mappings: {}
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}', 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://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'language' => 'en_US',
'whatsapp_channel_id' => 123,
'components' => [
[
'text' => '<string>',
'buttons' => [
[
'text' => '<string>',
'url' => '<string>',
'phone_number' => '<string>'
]
],
'cards' => [
[
'components' => '<array>'
]
]
]
],
'variable_mappings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<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.patch("https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
]
}
],
"variable_mappings": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}Authorizations
All API requests must include the api_access_token header with a valid agent or administrator token.
Body
application/json
Available options:
MARKETING, UTILITY, AUTHENTICATION Example:
"en_US"
Variable format style for body placeholders
Available options:
named, positional Show child attributes
Show child attributes
Map of variable names to contact attribute paths
Show child attributes
Show child attributes
Response
Template updated
Available options:
MARKETING, UTILITY, AUTHENTICATION Example:
"en_US"
Available options:
draft, pending, approved, rejected, paused Available options:
named, positional Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Update WhatsApp template
curl --request PATCH \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
]
}
],
"variable_mappings": {}
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}"
payload = {
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [{ "components": "<array>" }]
}
],
"variable_mappings": {}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
language: 'en_US',
whatsapp_channel_id: 123,
components: [
{
text: '<string>',
buttons: [{text: '<string>', url: '<string>', phone_number: '<string>'}],
cards: [{components: '<array>'}]
}
],
variable_mappings: {}
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}', 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://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'language' => 'en_US',
'whatsapp_channel_id' => 123,
'components' => [
[
'text' => '<string>',
'buttons' => [
[
'text' => '<string>',
'url' => '<string>',
'phone_number' => '<string>'
]
],
'cards' => [
[
'components' => '<array>'
]
]
]
],
'variable_mappings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<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.patch("https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/whatsapp_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"language\": \"en_US\",\n \"whatsapp_channel_id\": 123,\n \"components\": [\n {\n \"text\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ]\n }\n ],\n \"variable_mappings\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"language": "en_US",
"whatsapp_channel_id": 123,
"components": [
{
"text": "<string>",
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
]
}
],
"variable_mappings": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"errors": [
"<string>"
]
}
