WhatsApp Templates
Create Template
Creates a new Template
POST
/
api
/
v1
/
whatsapp-templates
/
cURL
curl --request POST \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"language": "en",
"parameterFormat": "POSITIONAL",
"components": [
{}
]
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/"
payload = {
"name": "<string>",
"language": "en",
"parameterFormat": "POSITIONAL",
"components": [{}]
}
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: '<string>',
language: 'en',
parameterFormat: 'POSITIONAL',
components: [{}]
})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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' => '<string>',
'language' => 'en',
'parameterFormat' => 'POSITIONAL',
'components' => [
[
]
]
]),
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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"category": "UTILITY",
"parameterFormat": "<string>",
"accountLinks": [
{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountName": "<string>",
"wabaId": "<string>",
"metaTemplateId": "<string>",
"qualityScore": "<string>",
"rejectionReason": "<string>",
"status": "DRAFT"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"language": "<string>",
"components": "<unknown>"
}This endpoint lets you create a new Template.
Authorizations
API key authentication. Pass your API key in the X-API-Key header.
Body
application/json
Input for creating a new local WhatsApp template (draft).
Maximum string length:
512UTILITY- UTILITYMARKETING- MARKETINGAUTHENTICATION- AUTHENTICATION
Available options:
UTILITY, MARKETING, AUTHENTICATION Maximum string length:
10Parameter format: POSITIONAL for {{1}}, {{2}} or NAMED for {{first_name}}, {{order_number}}
POSITIONAL- POSITIONALNAMED- NAMED
Available options:
POSITIONAL, NAMED Show child attributes
Show child attributes
Response
201 - application/json
Serializer for local WhatsApp templates with account links.
Maximum string length:
512UTILITY- UtilityMARKETING- MarketingAUTHENTICATION- Authentication
Available options:
UTILITY, MARKETING, AUTHENTICATION Show child attributes
Show child attributes
Maximum string length:
10Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"language": "en",
"parameterFormat": "POSITIONAL",
"components": [
{}
]
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/"
payload = {
"name": "<string>",
"language": "en",
"parameterFormat": "POSITIONAL",
"components": [{}]
}
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: '<string>',
language: 'en',
parameterFormat: 'POSITIONAL',
components: [{}]
})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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' => '<string>',
'language' => 'en',
'parameterFormat' => 'POSITIONAL',
'components' => [
[
]
]
]),
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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-templates/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/whatsapp-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\": \"<string>\",\n \"language\": \"en\",\n \"parameterFormat\": \"POSITIONAL\",\n \"components\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"category": "UTILITY",
"parameterFormat": "<string>",
"accountLinks": [
{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountName": "<string>",
"wabaId": "<string>",
"metaTemplateId": "<string>",
"qualityScore": "<string>",
"rejectionReason": "<string>",
"status": "DRAFT"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"language": "<string>",
"components": "<unknown>"
}