About this API
This API is used for creating text templates with body, header and quick reply.
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
apikeyYOUR_WABA_API_KEYPath Parameters
Substitute these placeholders in the endpoint URL before sending the request.
wabaidstringRequiredResource identifier for wabaid.Request Body
Send a application/json payload. Replace placeholder values with data from your integration.
{
"name": "welcome_postman_new_sne124", "category": "MARKETING",
"components": [
{"type":"BODY","text":"Dear {{1}}, Thank you for registering with Pinnacle Teleservices
and providing consent to receive notifications using WhatsApp. \\r\\n\\r\\nWe request you
to kindly save this number.\\r\\n\\r\\nTo get started, please type help*.\\r\\nYou can
reply with STOP* anytime you wish to stop communication through this
channel\\r\\nRegards,\\r\\n{{2}}{{2}}","example":{"body_text":[["User1","Pinnacle"]]}},{"typ
e":"HEADER","format":"TEXT","text":
"Welcome{{1}}","example":{"header_text":["header-text"]
}},{"type":"FOOTER","text":"welcome to
pinnacle"},{"type":"BUTTONS","buttons":[{"type":"QUICK_REPLY","text":"button1"},{"type"
:"Q
UICK_REPLY","text":"button2"},{"type":"QUICK_REPLY","text":"button3"}]}
],
"language": "en_US",
"allow_category_change": true
}{
"type": "object",
"properties": {
"raw_example": {
"type": "string"
}
}
}Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
curl --request POST 'https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates' \
--header 'apikey: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"raw_example": "{\n\"name\": \"welcome_postman_new_sne124\", \"category\": \"MARKETING\",\n\"components\": [\n{\"type\":\"BODY\",\"text\":\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\nand providing consent to receive notifications using WhatsApp. \\\\r\\\\n\\\\r\\\\nWe request you\nto kindly save this number.\\\\r\\\\n\\\\r\\\\nTo get started, please type help*.\\\\r\\\\nYou can\nreply with STOP* anytime you wish to stop communication through this\nchannel\\\\r\\\\nRegards,\\\\r\\\\n{{2}}{{2}}\",\"example\":{\"body_text\":[[\"User1\",\"Pinnacle\"]]}},{\"typ\ne\":\"HEADER\",\"format\":\"TEXT\",\"text\":\n\"Welcome{{1}}\",\"example\":{\"header_text\":[\"header-text\"]\n}},{\"type\":\"FOOTER\",\"text\":\"welcome to\npinnacle\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"QUICK_REPLY\",\"text\":\"button1\"},{\"type\"\n:\"Q\nUICK_REPLY\",\"text\":\"button2\"},{\"type\":\"QUICK_REPLY\",\"text\":\"button3\"}]}\n\n],\n\"language\": \"en_US\",\n\"allow_category_change\": true\n}"
}'const response = await fetch('https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates', {
method: 'POST',
headers: {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"raw_example": "{\n\"name\": \"welcome_postman_new_sne124\", \"category\": \"MARKETING\",\n\"components\": [\n{\"type\":\"BODY\",\"text\":\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\nand providing consent to receive notifications using WhatsApp. \\\\r\\\\n\\\\r\\\\nWe request you\nto kindly save this number.\\\\r\\\\n\\\\r\\\\nTo get started, please type help*.\\\\r\\\\nYou can\nreply with STOP* anytime you wish to stop communication through this\nchannel\\\\r\\\\nRegards,\\\\r\\\\n{{2}}{{2}}\",\"example\":{\"body_text\":[[\"User1\",\"Pinnacle\"]]}},{\"typ\ne\":\"HEADER\",\"format\":\"TEXT\",\"text\":\n\"Welcome{{1}}\",\"example\":{\"header_text\":[\"header-text\"]\n}},{\"type\":\"FOOTER\",\"text\":\"welcome to\npinnacle\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"QUICK_REPLY\",\"text\":\"button1\"},{\"type\"\n:\"Q\nUICK_REPLY\",\"text\":\"button2\"},{\"type\":\"QUICK_REPLY\",\"text\":\"button3\"}]}\n\n],\n\"language\": \"en_US\",\n\"allow_category_change\": true\n}"
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);const response = await fetch('https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates', {
method: 'POST',
headers: {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"raw_example": "{\n\"name\": \"welcome_postman_new_sne124\", \"category\": \"MARKETING\",\n\"components\": [\n{\"type\":\"BODY\",\"text\":\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\nand providing consent to receive notifications using WhatsApp. \\\\r\\\\n\\\\r\\\\nWe request you\nto kindly save this number.\\\\r\\\\n\\\\r\\\\nTo get started, please type help*.\\\\r\\\\nYou can\nreply with STOP* anytime you wish to stop communication through this\nchannel\\\\r\\\\nRegards,\\\\r\\\\n{{2}}{{2}}\",\"example\":{\"body_text\":[[\"User1\",\"Pinnacle\"]]}},{\"typ\ne\":\"HEADER\",\"format\":\"TEXT\",\"text\":\n\"Welcome{{1}}\",\"example\":{\"header_text\":[\"header-text\"]\n}},{\"type\":\"FOOTER\",\"text\":\"welcome to\npinnacle\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"QUICK_REPLY\",\"text\":\"button1\"},{\"type\"\n:\"Q\nUICK_REPLY\",\"text\":\"button2\"},{\"type\":\"QUICK_REPLY\",\"text\":\"button3\"}]}\n\n],\n\"language\": \"en_US\",\n\"allow_category_change\": true\n}"
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import json
import requests
url = 'https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates'
headers = {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
}
payload = json.loads(r'''{
"raw_example": "{\\n\\"name\\": \\"welcome_postman_new_sne124\\", \\"category\\": \\"MARKETING\\",\\n\\"components\\": [\\n{\\"type\\":\\"BODY\\",\\"text\\":\\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\\nand providing consent to receive notifications using WhatsApp. \\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nWe request you\\nto kindly save this number.\\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nTo get started, please type help*.\\\\\\\\r\\\\\\\\nYou can\\nreply with STOP* anytime you wish to stop communication through this\\nchannel\\\\\\\\r\\\\\\\\nRegards,\\\\\\\\r\\\\\\\\n{{2}}{{2}}\\",\\"example\\":{\\"body_text\\":[[\\"User1\\",\\"Pinnacle\\"]]}},{\\"typ\\ne\\":\\"HEADER\\",\\"format\\":\\"TEXT\\",\\"text\\":\\n\\"Welcome{{1}}\\",\\"example\\":{\\"header_text\\":[\\"header-text\\"]\\n}},{\\"type\\":\\"FOOTER\\",\\"text\\":\\"welcome to\\npinnacle\\"},{\\"type\\":\\"BUTTONS\\",\\"buttons\\":[{\\"type\\":\\"QUICK_REPLY\\",\\"text\\":\\"button1\\"},{\\"type\\"\\n:\\"Q\\nUICK_REPLY\\",\\"text\\":\\"button2\\"},{\\"type\\":\\"QUICK_REPLY\\",\\"text\\":\\"button3\\"}]}\\n\\n],\\n\\"language\\": \\"en_US\\",\\n\\"allow_category_change\\": true\\n}"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
String body = """
{
"raw_example": "{\n\"name\": \"welcome_postman_new_sne124\", \"category\": \"MARKETING\",\n\"components\": [\n{\"type\":\"BODY\",\"text\":\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\nand providing consent to receive notifications using WhatsApp. \\\\r\\\\n\\\\r\\\\nWe request you\nto kindly save this number.\\\\r\\\\n\\\\r\\\\nTo get started, please type help*.\\\\r\\\\nYou can\nreply with STOP* anytime you wish to stop communication through this\nchannel\\\\r\\\\nRegards,\\\\r\\\\n{{2}}{{2}}\",\"example\":{\"body_text\":[[\"User1\",\"Pinnacle\"]]}},{\"typ\ne\":\"HEADER\",\"format\":\"TEXT\",\"text\":\n\"Welcome{{1}}\",\"example\":{\"header_text\":[\"header-text\"]\n}},{\"type\":\"FOOTER\",\"text\":\"welcome to\npinnacle\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"QUICK_REPLY\",\"text\":\"button1\"},{\"type\"\n:\"Q\nUICK_REPLY\",\"text\":\"button2\"},{\"type\":\"QUICK_REPLY\",\"text\":\"button3\"}]}\n\n],\n\"language\": \"en_US\",\n\"allow_category_change\": true\n}"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates"))
.header("apikey", "<API_KEY>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());<?php
$curl = curl_init();
$payload = '{
"raw_example": "{\\n\\"name\\": \\"welcome_postman_new_sne124\\", \\"category\\": \\"MARKETING\\",\\n\\"components\\": [\\n{\\"type\\":\\"BODY\\",\\"text\\":\\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\\nand providing consent to receive notifications using WhatsApp. \\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nWe request you\\nto kindly save this number.\\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nTo get started, please type help*.\\\\\\\\r\\\\\\\\nYou can\\nreply with STOP* anytime you wish to stop communication through this\\nchannel\\\\\\\\r\\\\\\\\nRegards,\\\\\\\\r\\\\\\\\n{{2}}{{2}}\\",\\"example\\":{\\"body_text\\":[[\\"User1\\",\\"Pinnacle\\"]]}},{\\"typ\\ne\\":\\"HEADER\\",\\"format\\":\\"TEXT\\",\\"text\\":\\n\\"Welcome{{1}}\\",\\"example\\":{\\"header_text\\":[\\"header-text\\"]\\n}},{\\"type\\":\\"FOOTER\\",\\"text\\":\\"welcome to\\npinnacle\\"},{\\"type\\":\\"BUTTONS\\",\\"buttons\\":[{\\"type\\":\\"QUICK_REPLY\\",\\"text\\":\\"button1\\"},{\\"type\\"\\n:\\"Q\\nUICK_REPLY\\",\\"text\\":\\"button2\\"},{\\"type\\":\\"QUICK_REPLY\\",\\"text\\":\\"button3\\"}]}\\n\\n],\\n\\"language\\": \\"en_US\\",\\n\\"allow_category_change\\": true\\n}"
}';
curl_setopt_array($curl, [
CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["apikey: <API_KEY>","Content-Type: application/json"],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var json = """
{
"raw_example": "{\n\"name\": \"welcome_postman_new_sne124\", \"category\": \"MARKETING\",\n\"components\": [\n{\"type\":\"BODY\",\"text\":\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\nand providing consent to receive notifications using WhatsApp. \\\\r\\\\n\\\\r\\\\nWe request you\nto kindly save this number.\\\\r\\\\n\\\\r\\\\nTo get started, please type help*.\\\\r\\\\nYou can\nreply with STOP* anytime you wish to stop communication through this\nchannel\\\\r\\\\nRegards,\\\\r\\\\n{{2}}{{2}}\",\"example\":{\"body_text\":[[\"User1\",\"Pinnacle\"]]}},{\"typ\ne\":\"HEADER\",\"format\":\"TEXT\",\"text\":\n\"Welcome{{1}}\",\"example\":{\"header_text\":[\"header-text\"]\n}},{\"type\":\"FOOTER\",\"text\":\"welcome to\npinnacle\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"QUICK_REPLY\",\"text\":\"button1\"},{\"type\"\n:\"Q\nUICK_REPLY\",\"text\":\"button2\"},{\"type\":\"QUICK_REPLY\",\"text\":\"button3\"}]}\n\n],\n\"language\": \"en_US\",\n\"allow_category_change\": true\n}"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"bytes"
)
func main() {
request, err := http.NewRequest("POST", "https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates", bytes.NewBufferString("{\n \"raw_example\": \"{\\n\\\"name\\\": \\\"welcome_postman_new_sne124\\\", \\\"category\\\": \\\"MARKETING\\\",\\n\\\"components\\\": [\\n{\\\"type\\\":\\\"BODY\\\",\\\"text\\\":\\\"Dear {{1}}, Thank you for registering with Pinnacle Teleservices\\nand providing consent to receive notifications using WhatsApp. \\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nWe request you\\nto kindly save this number.\\\\\\\\r\\\\\\\\n\\\\\\\\r\\\\\\\\nTo get started, please type help*.\\\\\\\\r\\\\\\\\nYou can\\nreply with STOP* anytime you wish to stop communication through this\\nchannel\\\\\\\\r\\\\\\\\nRegards,\\\\\\\\r\\\\\\\\n{{2}}{{2}}\\\",\\\"example\\\":{\\\"body_text\\\":[[\\\"User1\\\",\\\"Pinnacle\\\"]]}},{\\\"typ\\ne\\\":\\\"HEADER\\\",\\\"format\\\":\\\"TEXT\\\",\\\"text\\\":\\n\\\"Welcome{{1}}\\\",\\\"example\\\":{\\\"header_text\\\":[\\\"header-text\\\"]\\n}},{\\\"type\\\":\\\"FOOTER\\\",\\\"text\\\":\\\"welcome to\\npinnacle\\\"},{\\\"type\\\":\\\"BUTTONS\\\",\\\"buttons\\\":[{\\\"type\\\":\\\"QUICK_REPLY\\\",\\\"text\\\":\\\"button1\\\"},{\\\"type\\\"\\n:\\\"Q\\nUICK_REPLY\\\",\\\"text\\\":\\\"button2\\\"},{\\\"type\\\":\\\"QUICK_REPLY\\\",\\\"text\\\":\\\"button3\\\"}]}\\n\\n],\\n\\\"language\\\": \\\"en_US\\\",\\n\\\"allow_category_change\\\": true\\n}\"\n}"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Accept", "application/json")
request.Header.Set("apikey", "<API_KEY>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{
"200": {
"id": "123412341234123",
"status": "APPROVED",
"category": "MARKETING"
}
}{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"category": {
"type": "string"
}
}
}Status Codes
200The request was successful.400Bad request or invalid parameters.401API key is missing or invalid.403The request is not authorized for this resource.404The requested resource was not found.500The server encountered an error.