API Reference
View as Markdown Open in ChatGPT Open in Claude
POST
WhatsApp API · Templates · v3.0

Video Carousel Template with Body Placeholder

This API is used for creating video carousel templates with body placeholders.

https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates
chatOpen WhatsApp SimulatorTest this payload in the iPhone previewarrow_downward
infoOverview

About this API

This API is used for creating video carousel templates with body placeholders.

MethodPOST
Versionv3.0
Base URLhttps://partnersv1.pinbot.ai/v3
Content Typeapplication/json
keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader
Field nameapikey
Example valueYOUR_WABA_API_KEY
routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

NameTypeRequirementDescription
wabaidstringRequiredResource identifier for wabaid.
uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

{
"name": "testv2_carouselimgsm1a1",
"language": "en_US",
"category": "MARKETING",
"allow_category_change": true,
"components": [
{"type": "body",
"text": " hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.",
"example": {
"body_text": [
[
"15OFF",
"15%"
]
]
}
},{
"type": "CAROUSEL",
"cards": [

{
"components": [
{
"type": "header",
"format": "video",
"example": {
"header_handle": [
"4::aW1hZ2UvanBlZw==:ARZsON6K-8ukPIq2h95wJ9UUCr439vX2odOWPJ0TjPBISD0
WIf04LiFVs--EFJdZjCCI8gOUGXVN_1Vn8rz q4t6XIc-R7ryeLPAAnQ2bHopw:e:17119
80467:1849455295211775:100061459561823:ARY_I5AUJyyOhp-Yzdw"
]
}
},
{
"type": "body",
"text": "Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off
all produce.",
"example": {
"body_text": [
[
"prasad1",
"Hajare1"
]
]
}
},
{
"type": "buttons",
"buttons": [
{
"type": "quick_reply",
"text": "Send more like this"
},
{

"url": "https:
"example": [
"https:
],
"type": "url",
"text": "Buy now"
}
]
}
]
}
]
}
]
}
{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}
smartphoneEmbedded Signup Sandbox

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.

scienceSimulation onlySample credentials are stored locally in this browser.
Edit the documented request body, then test it in the phone preview.

9:41⌁
codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

shield_lockCredentials protectedAdd secrets only in your secure server environment.
downloadSDK
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\": \"testv2_carouselimgsm1a1\",\n\"language\": \"en_US\",\n\"category\": \"MARKETING\",\n\"allow_category_change\": true,\n\"components\": [\n{\"type\": \"body\",\n\"text\": \" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\",\n\"example\": {\n\"body_text\": [\n[\n\"15OFF\",\n\"15%\"\n]\n]\n}\n},{\n\"type\": \"CAROUSEL\",\n\"cards\": [\n\n{\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"video\",\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\"text\": \"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\nall produce.\",\n\"example\": {\n\"body_text\": [\n[\n\"prasad1\",\n\"Hajare1\"\n]\n]\n}\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Send more like this\"\n},\n{\n\n\"url\": \"https:\n\"example\": [\n\"https:\n],\n\"type\": \"url\",\n\"text\": \"Buy now\"\n}\n]\n}\n]\n}\n]\n}\n]\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\": \"testv2_carouselimgsm1a1\",\n\"language\": \"en_US\",\n\"category\": \"MARKETING\",\n\"allow_category_change\": true,\n\"components\": [\n{\"type\": \"body\",\n\"text\": \" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\",\n\"example\": {\n\"body_text\": [\n[\n\"15OFF\",\n\"15%\"\n]\n]\n}\n},{\n\"type\": \"CAROUSEL\",\n\"cards\": [\n\n{\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"video\",\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\"text\": \"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\nall produce.\",\n\"example\": {\n\"body_text\": [\n[\n\"prasad1\",\n\"Hajare1\"\n]\n]\n}\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Send more like this\"\n},\n{\n\n\"url\": \"https:\n\"example\": [\n\"https:\n],\n\"type\": \"url\",\n\"text\": \"Buy now\"\n}\n]\n}\n]\n}\n]\n}\n]\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\": \"testv2_carouselimgsm1a1\",\n\"language\": \"en_US\",\n\"category\": \"MARKETING\",\n\"allow_category_change\": true,\n\"components\": [\n{\"type\": \"body\",\n\"text\": \" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\",\n\"example\": {\n\"body_text\": [\n[\n\"15OFF\",\n\"15%\"\n]\n]\n}\n},{\n\"type\": \"CAROUSEL\",\n\"cards\": [\n\n{\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"video\",\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\"text\": \"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\nall produce.\",\n\"example\": {\n\"body_text\": [\n[\n\"prasad1\",\n\"Hajare1\"\n]\n]\n}\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Send more like this\"\n},\n{\n\n\"url\": \"https:\n\"example\": [\n\"https:\n],\n\"type\": \"url\",\n\"text\": \"Buy now\"\n}\n]\n}\n]\n}\n]\n}\n]\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\\": \\"testv2_carouselimgsm1a1\\",\\n\\"language\\": \\"en_US\\",\\n\\"category\\": \\"MARKETING\\",\\n\\"allow_category_change\\": true,\\n\\"components\\": [\\n{\\"type\\": \\"body\\",\\n\\"text\\": \\" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\\",\\n\\"example\\": {\\n\\"body_text\\": [\\n[\\n\\"15OFF\\",\\n\\"15%\\"\\n]\\n]\\n}\\n},{\\n\\"type\\": \\"CAROUSEL\\",\\n\\"cards\\": [\\n\\n{\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\"format\\": \\"video\\",\\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\\"text\\": \\"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\\nall produce.\\",\\n\\"example\\": {\\n\\"body_text\\": [\\n[\\n\\"prasad1\\",\\n\\"Hajare1\\"\\n]\\n]\\n}\\n},\\n{\\n\\"type\\": \\"buttons\\",\\n\\"buttons\\": [\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Send more like this\\"\\n},\\n{\\n\\n\\"url\\": \\"https:\\n\\"example\\": [\\n\\"https:\\n],\\n\\"type\\": \\"url\\",\\n\\"text\\": \\"Buy now\\"\\n}\\n]\\n}\\n]\\n}\\n]\\n}\\n]\\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\": \"testv2_carouselimgsm1a1\",\n\"language\": \"en_US\",\n\"category\": \"MARKETING\",\n\"allow_category_change\": true,\n\"components\": [\n{\"type\": \"body\",\n\"text\": \" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\",\n\"example\": {\n\"body_text\": [\n[\n\"15OFF\",\n\"15%\"\n]\n]\n}\n},{\n\"type\": \"CAROUSEL\",\n\"cards\": [\n\n{\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"video\",\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\"text\": \"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\nall produce.\",\n\"example\": {\n\"body_text\": [\n[\n\"prasad1\",\n\"Hajare1\"\n]\n]\n}\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Send more like this\"\n},\n{\n\n\"url\": \"https:\n\"example\": [\n\"https:\n],\n\"type\": \"url\",\n\"text\": \"Buy now\"\n}\n]\n}\n]\n}\n]\n}\n]\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\\": \\"testv2_carouselimgsm1a1\\",\\n\\"language\\": \\"en_US\\",\\n\\"category\\": \\"MARKETING\\",\\n\\"allow_category_change\\": true,\\n\\"components\\": [\\n{\\"type\\": \\"body\\",\\n\\"text\\": \\" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\\",\\n\\"example\\": {\\n\\"body_text\\": [\\n[\\n\\"15OFF\\",\\n\\"15%\\"\\n]\\n]\\n}\\n},{\\n\\"type\\": \\"CAROUSEL\\",\\n\\"cards\\": [\\n\\n{\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\"format\\": \\"video\\",\\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\\"text\\": \\"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\\nall produce.\\",\\n\\"example\\": {\\n\\"body_text\\": [\\n[\\n\\"prasad1\\",\\n\\"Hajare1\\"\\n]\\n]\\n}\\n},\\n{\\n\\"type\\": \\"buttons\\",\\n\\"buttons\\": [\\n{\\n\\"type\\": \\"quick_reply\\",\\n\\"text\\": \\"Send more like this\\"\\n},\\n{\\n\\n\\"url\\": \\"https:\\n\\"example\\": [\\n\\"https:\\n],\\n\\"type\\": \\"url\\",\\n\\"text\\": \\"Buy now\\"\\n}\\n]\\n}\\n]\\n}\\n]\\n}\\n]\\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\": \"testv2_carouselimgsm1a1\",\n\"language\": \"en_US\",\n\"category\": \"MARKETING\",\n\"allow_category_change\": true,\n\"components\": [\n{\"type\": \"body\",\n\"text\": \" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\",\n\"example\": {\n\"body_text\": [\n[\n\"15OFF\",\n\"15%\"\n]\n]\n}\n},{\n\"type\": \"CAROUSEL\",\n\"cards\": [\n\n{\n\"components\": [\n{\n\"type\": \"header\",\n\"format\": \"video\",\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\"text\": \"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\nall produce.\",\n\"example\": {\n\"body_text\": [\n[\n\"prasad1\",\n\"Hajare1\"\n]\n]\n}\n},\n{\n\"type\": \"buttons\",\n\"buttons\": [\n{\n\"type\": \"quick_reply\",\n\"text\": \"Send more like this\"\n},\n{\n\n\"url\": \"https:\n\"example\": [\n\"https:\n],\n\"type\": \"url\",\n\"text\": \"Buy now\"\n}\n]\n}\n]\n}\n]\n}\n]\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\\\": \\\"testv2_carouselimgsm1a1\\\",\\n\\\"language\\\": \\\"en_US\\\",\\n\\\"category\\\": \\\"MARKETING\\\",\\n\\\"allow_category_change\\\": true,\\n\\\"components\\\": [\\n{\\\"type\\\": \\\"body\\\",\\n\\\"text\\\": \\\" hii from pinnacle, winter is Use code {{1}} to get {{2}} off order.\\\",\\n\\\"example\\\": {\\n\\\"body_text\\\": [\\n[\\n\\\"15OFF\\\",\\n\\\"15%\\\"\\n]\\n]\\n}\\n},{\\n\\\"type\\\": \\\"CAROUSEL\\\",\\n\\\"cards\\\": [\\n\\n{\\n\\\"components\\\": [\\n{\\n\\\"type\\\": \\\"header\\\",\\n\\\"format\\\": \\\"video\\\",\\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\\\"text\\\": \\\"Rare lemons for unique cocktails. Use code {{1}} to get {{2}} off\\nall produce.\\\",\\n\\\"example\\\": {\\n\\\"body_text\\\": [\\n[\\n\\\"prasad1\\\",\\n\\\"Hajare1\\\"\\n]\\n]\\n}\\n},\\n{\\n\\\"type\\\": \\\"buttons\\\",\\n\\\"buttons\\\": [\\n{\\n\\\"type\\\": \\\"quick_reply\\\",\\n\\\"text\\\": \\\"Send more like this\\\"\\n},\\n{\\n\\n\\\"url\\\": \\\"https:\\n\\\"example\\\": [\\n\\\"https:\\n],\\n\\\"type\\\": \\\"url\\\",\\n\\\"text\\\": \\\"Buy now\\\"\\n}\\n]\\n}\\n]\\n}\\n]\\n}\\n]\\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))
}
downloadOutput

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"
    }
  }
}
ruleHTTP Responses

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.
Global API SearchProducts, versions, endpoints, paths, and payload fields
Esc
Full search page
manage_searchSearch the complete API catalogEnter at least two characters to begin.