About this API
This API is used for creating image templates with multiple buttons.
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": "sample_partners_api_img_1_a_1",
"category": "MARKETING",
"components": [
{
"type": "header",
"format": "image",
"example": {
"header_handle": [
"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0
WIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119
80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
]
}
},
{
"type": "body",
"text": "Hey user,\r\nWelceleservices pvt ltd.\r\n\r\nRegards,\r\nPinnacle"
},
{
"type": "footer",
"text": "Use the buge your marketing subscriptions"
},
{
"type": "buttons",
"buttons": [
{
"type": "quick_reply",
"text": "Button1"
},
{
"type": "quick_reply",
"text": "Button2"
},
{
"type": "quick_reply",
"text": "Button3"
},
{
"type": "quick_reply",
"text": "Button4"
},
{
"type": "quick_reply",
"text": "Button5"
},
{
"type": "quick_reply",
"text": "Button6"
},
{
"type": "quick_reply",
"text": "Button7"
},
{
"type": "url",
"text": "click",
"url":
"https:
},
{
"type": "phone_number",
"text": "Call",
"phone_number": "+919921447944"
}
]
}
],
"language": "en_US",
"allow_category_change": true
}{
"type": "object",
"properties": {
"raw_example": {
"type": "string"
}
}
}Test with simulated WABA credentials
Use the sample WABA ID and WABA number produced by the Embedded Signup simulation. Sending here never calls the real WhatsApp API.
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\": \"sample_partners_api_img_1_a_1\",\n\"category\": \"MARKETING\",\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"image\",\n\"example\": {\n\"header_handle\": [\n\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\"\n]\n}\n},\n{\n\"type\": \"body\",\n\n\"text\": \"Hey user,\\r\\nWelceleservices pvt ltd.\\r\\n\\r\\nRegards,\\r\\nPinnacle\"\n},\n{\n\"type\": \"footer\",\n\"text\": \"Use the buge your marketing subscriptions\"\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button1\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button2\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button3\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button4\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button5\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button6\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button7\"\n},\n\n{\n\"type\": \"url\",\n\"text\": \"click\",\n\"url\":\n\"https:\n},\n{\n\"type\": \"phone_number\",\n\"text\": \"Call\",\n\"phone_number\": \"+919921447944\"\n}\n]\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\": \"sample_partners_api_img_1_a_1\",\n\"category\": \"MARKETING\",\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"image\",\n\"example\": {\n\"header_handle\": [\n\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\"\n]\n}\n},\n{\n\"type\": \"body\",\n\n\"text\": \"Hey user,\\r\\nWelceleservices pvt ltd.\\r\\n\\r\\nRegards,\\r\\nPinnacle\"\n},\n{\n\"type\": \"footer\",\n\"text\": \"Use the buge your marketing subscriptions\"\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button1\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button2\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button3\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button4\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button5\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button6\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button7\"\n},\n\n{\n\"type\": \"url\",\n\"text\": \"click\",\n\"url\":\n\"https:\n},\n{\n\"type\": \"phone_number\",\n\"text\": \"Call\",\n\"phone_number\": \"+919921447944\"\n}\n]\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\": \"sample_partners_api_img_1_a_1\",\n\"category\": \"MARKETING\",\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"image\",\n\"example\": {\n\"header_handle\": [\n\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\"\n]\n}\n},\n{\n\"type\": \"body\",\n\n\"text\": \"Hey user,\\r\\nWelceleservices pvt ltd.\\r\\n\\r\\nRegards,\\r\\nPinnacle\"\n},\n{\n\"type\": \"footer\",\n\"text\": \"Use the buge your marketing subscriptions\"\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button1\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button2\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button3\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button4\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button5\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button6\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button7\"\n},\n\n{\n\"type\": \"url\",\n\"text\": \"click\",\n\"url\":\n\"https:\n},\n{\n\"type\": \"phone_number\",\n\"text\": \"Call\",\n\"phone_number\": \"+919921447944\"\n}\n]\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\\": \\"sample_partners_api_img_1_a_1\\",\\n\\"category\\": \\"MARKETING\\",\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\"format\\": \\"image\\",\\n\\"example\\": {\\n\\"header_handle\\": [\\n\\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\\"\\n]\\n}\\n},\\n{\\n\\"type\\": \\"body\\",\\n\\n\\"text\\": \\"Hey user,\\\\r\\\\nWelceleservices pvt ltd.\\\\r\\\\n\\\\r\\\\nRegards,\\\\r\\\\nPinnacle\\"\\n},\\n{\\n\\"type\\": \\"footer\\",\\n\\"text\\": \\"Use the buge your marketing subscriptions\\"\\n},\\n{\\n\\"type\\": \\"buttons\\",\\n\\"buttons\\": [\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button1\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button2\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button3\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button4\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button5\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button6\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button7\\"\\n},\\n\\n{\\n\\"type\\": \\"url\\",\\n\\"text\\": \\"click\\",\\n\\"url\\":\\n\\"https:\\n},\\n{\\n\\"type\\": \\"phone_number\\",\\n\\"text\\": \\"Call\\",\\n\\"phone_number\\": \\"+919921447944\\"\\n}\\n]\\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\": \"sample_partners_api_img_1_a_1\",\n\"category\": \"MARKETING\",\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"image\",\n\"example\": {\n\"header_handle\": [\n\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\"\n]\n}\n},\n{\n\"type\": \"body\",\n\n\"text\": \"Hey user,\\r\\nWelceleservices pvt ltd.\\r\\n\\r\\nRegards,\\r\\nPinnacle\"\n},\n{\n\"type\": \"footer\",\n\"text\": \"Use the buge your marketing subscriptions\"\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button1\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button2\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button3\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button4\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button5\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button6\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button7\"\n},\n\n{\n\"type\": \"url\",\n\"text\": \"click\",\n\"url\":\n\"https:\n},\n{\n\"type\": \"phone_number\",\n\"text\": \"Call\",\n\"phone_number\": \"+919921447944\"\n}\n]\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\\": \\"sample_partners_api_img_1_a_1\\",\\n\\"category\\": \\"MARKETING\\",\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\"format\\": \\"image\\",\\n\\"example\\": {\\n\\"header_handle\\": [\\n\\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\\"\\n]\\n}\\n},\\n{\\n\\"type\\": \\"body\\",\\n\\n\\"text\\": \\"Hey user,\\\\r\\\\nWelceleservices pvt ltd.\\\\r\\\\n\\\\r\\\\nRegards,\\\\r\\\\nPinnacle\\"\\n},\\n{\\n\\"type\\": \\"footer\\",\\n\\"text\\": \\"Use the buge your marketing subscriptions\\"\\n},\\n{\\n\\"type\\": \\"buttons\\",\\n\\"buttons\\": [\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button1\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button2\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button3\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button4\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button5\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button6\\"\\n},\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Button7\\"\\n},\\n\\n{\\n\\"type\\": \\"url\\",\\n\\"text\\": \\"click\\",\\n\\"url\\":\\n\\"https:\\n},\\n{\\n\\"type\\": \\"phone_number\\",\\n\\"text\\": \\"Call\\",\\n\\"phone_number\\": \\"+919921447944\\"\\n}\\n]\\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\": \"sample_partners_api_img_1_a_1\",\n\"category\": \"MARKETING\",\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"image\",\n\"example\": {\n\"header_handle\": [\n\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\"\n]\n}\n},\n{\n\"type\": \"body\",\n\n\"text\": \"Hey user,\\r\\nWelceleservices pvt ltd.\\r\\n\\r\\nRegards,\\r\\nPinnacle\"\n},\n{\n\"type\": \"footer\",\n\"text\": \"Use the buge your marketing subscriptions\"\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button1\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button2\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button3\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button4\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button5\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button6\"\n},\n{\n\"type\": \"quick_reply\",\n\"text\": \"Button7\"\n},\n\n{\n\"type\": \"url\",\n\"text\": \"click\",\n\"url\":\n\"https:\n},\n{\n\"type\": \"phone_number\",\n\"text\": \"Call\",\n\"phone_number\": \"+919921447944\"\n}\n]\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\\\": \\\"sample_partners_api_img_1_a_1\\\",\\n\\\"category\\\": \\\"MARKETING\\\",\\n\\\"components\\\": [\\n{\\n\\\"type\\\": \\\"header\\\",\\n\\\"format\\\": \\\"image\\\",\\n\\\"example\\\": {\\n\\\"header_handle\\\": [\\n\\\"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0\\nWIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119\\n80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw\\\"\\n]\\n}\\n},\\n{\\n\\\"type\\\": \\\"body\\\",\\n\\n\\\"text\\\": \\\"Hey user,\\\\r\\\\nWelceleservices pvt ltd.\\\\r\\\\n\\\\r\\\\nRegards,\\\\r\\\\nPinnacle\\\"\\n},\\n{\\n\\\"type\\\": \\\"footer\\\",\\n\\\"text\\\": \\\"Use the buge your marketing subscriptions\\\"\\n},\\n{\\n\\\"type\\\": \\\"buttons\\\",\\n\\\"buttons\\\": [\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button1\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button2\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button3\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button4\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button5\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button6\\\"\\n},\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Button7\\\"\\n},\\n\\n{\\n\\\"type\\\": \\\"url\\\",\\n\\\"text\\\": \\\"click\\\",\\n\\\"url\\\":\\n\\\"https:\\n},\\n{\\n\\\"type\\\": \\\"phone_number\\\",\\n\\\"text\\\": \\\"Call\\\",\\n\\\"phone_number\\\": \\\"+919921447944\\\"\\n}\\n]\\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.