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

Send Media Template Message

This API is used to send the media template message to the end user.

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

About this API

This API is used to send the media template message to the end user.

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
phone_number_idstringRequiredResource identifier for phone number id.
uploadInput

Request Body

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

{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "{{Recipient number}}",
"type": "template",
"template": {
"name": "template-name",
"language": {
"code": "language-and-locale-code"
},
"components": [
{
"type": "header",

"parameters": [
{
"type": "image",
"image": {
"link": "http(s):
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "text-string"
},
{
"type": "currency",
"currency": {
"fallback_value": "$100.99",
"code": "USD",
"amount_1000": 100990
}
},
{
"type": "date_time",
"date_time": {
"fallback_value": "February 25, 1977",

"day_of_week": 5,
"year": 1977,
"month": 2,
"day_of_month": 25,
"hour": 15,
"minute": 33,
"calendar": "GREGORIAN"
}
}
]
}
]
}
}
{
  "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/{phone_number_id}/messages' \
  --header 'apikey: <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient number}}\",\n\"type\": \"template\",\n\"template\": {\n\"name\": \"template-name\",\n\"language\": {\n\"code\": \"language-and-locale-code\"\n},\n\"components\": [\n{\n\"type\": \"header\",\n\n\"parameters\": [\n{\n\"type\": \"image\",\n\"image\": {\n\"link\": \"http(s):\n}\n}\n]\n},\n{\n\"type\": \"body\",\n\"parameters\": [\n{\n\"type\": \"text\",\n\"text\": \"text-string\"\n},\n{\n\"type\": \"currency\",\n\"currency\": {\n\"fallback_value\": \"$100.99\",\n\"code\": \"USD\",\n\"amount_1000\": 100990\n}\n},\n{\n\"type\": \"date_time\",\n\"date_time\": {\n\"fallback_value\": \"February 25, 1977\",\n\n\"day_of_week\": 5,\n\"year\": 1977,\n\"month\": 2,\n\"day_of_month\": 25,\n\"hour\": 15,\n\"minute\": 33,\n\"calendar\": \"GREGORIAN\"\n}\n}\n]\n}\n]\n}\n}"
}'
const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages', {
  method: 'POST',
  headers: {
    "apikey": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient number}}\",\n\"type\": \"template\",\n\"template\": {\n\"name\": \"template-name\",\n\"language\": {\n\"code\": \"language-and-locale-code\"\n},\n\"components\": [\n{\n\"type\": \"header\",\n\n\"parameters\": [\n{\n\"type\": \"image\",\n\"image\": {\n\"link\": \"http(s):\n}\n}\n]\n},\n{\n\"type\": \"body\",\n\"parameters\": [\n{\n\"type\": \"text\",\n\"text\": \"text-string\"\n},\n{\n\"type\": \"currency\",\n\"currency\": {\n\"fallback_value\": \"$100.99\",\n\"code\": \"USD\",\n\"amount_1000\": 100990\n}\n},\n{\n\"type\": \"date_time\",\n\"date_time\": {\n\"fallback_value\": \"February 25, 1977\",\n\n\"day_of_week\": 5,\n\"year\": 1977,\n\"month\": 2,\n\"day_of_month\": 25,\n\"hour\": 15,\n\"minute\": 33,\n\"calendar\": \"GREGORIAN\"\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/{phone_number_id}/messages', {
  method: 'POST',
  headers: {
    "apikey": "<API_KEY>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "raw_example": "{\n\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient number}}\",\n\"type\": \"template\",\n\"template\": {\n\"name\": \"template-name\",\n\"language\": {\n\"code\": \"language-and-locale-code\"\n},\n\"components\": [\n{\n\"type\": \"header\",\n\n\"parameters\": [\n{\n\"type\": \"image\",\n\"image\": {\n\"link\": \"http(s):\n}\n}\n]\n},\n{\n\"type\": \"body\",\n\"parameters\": [\n{\n\"type\": \"text\",\n\"text\": \"text-string\"\n},\n{\n\"type\": \"currency\",\n\"currency\": {\n\"fallback_value\": \"$100.99\",\n\"code\": \"USD\",\n\"amount_1000\": 100990\n}\n},\n{\n\"type\": \"date_time\",\n\"date_time\": {\n\"fallback_value\": \"February 25, 1977\",\n\n\"day_of_week\": 5,\n\"year\": 1977,\n\"month\": 2,\n\"day_of_month\": 25,\n\"hour\": 15,\n\"minute\": 33,\n\"calendar\": \"GREGORIAN\"\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/{phone_number_id}/messages'
headers = {
  "apikey": "<API_KEY>",
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "raw_example": "{\\n\\"messaging_product\\": \\"whatsapp\\",\\n\\"recipient_type\\": \\"individual\\",\\n\\"to\\": \\"{{Recipient number}}\\",\\n\\"type\\": \\"template\\",\\n\\"template\\": {\\n\\"name\\": \\"template-name\\",\\n\\"language\\": {\\n\\"code\\": \\"language-and-locale-code\\"\\n},\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\n\\"parameters\\": [\\n{\\n\\"type\\": \\"image\\",\\n\\"image\\": {\\n\\"link\\": \\"http(s):\\n}\\n}\\n]\\n},\\n{\\n\\"type\\": \\"body\\",\\n\\"parameters\\": [\\n{\\n\\"type\\": \\"text\\",\\n\\"text\\": \\"text-string\\"\\n},\\n{\\n\\"type\\": \\"currency\\",\\n\\"currency\\": {\\n\\"fallback_value\\": \\"$100.99\\",\\n\\"code\\": \\"USD\\",\\n\\"amount_1000\\": 100990\\n}\\n},\\n{\\n\\"type\\": \\"date_time\\",\\n\\"date_time\\": {\\n\\"fallback_value\\": \\"February 25, 1977\\",\\n\\n\\"day_of_week\\": 5,\\n\\"year\\": 1977,\\n\\"month\\": 2,\\n\\"day_of_month\\": 25,\\n\\"hour\\": 15,\\n\\"minute\\": 33,\\n\\"calendar\\": \\"GREGORIAN\\"\\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\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient number}}\",\n\"type\": \"template\",\n\"template\": {\n\"name\": \"template-name\",\n\"language\": {\n\"code\": \"language-and-locale-code\"\n},\n\"components\": [\n{\n\"type\": \"header\",\n\n\"parameters\": [\n{\n\"type\": \"image\",\n\"image\": {\n\"link\": \"http(s):\n}\n}\n]\n},\n{\n\"type\": \"body\",\n\"parameters\": [\n{\n\"type\": \"text\",\n\"text\": \"text-string\"\n},\n{\n\"type\": \"currency\",\n\"currency\": {\n\"fallback_value\": \"$100.99\",\n\"code\": \"USD\",\n\"amount_1000\": 100990\n}\n},\n{\n\"type\": \"date_time\",\n\"date_time\": {\n\"fallback_value\": \"February 25, 1977\",\n\n\"day_of_week\": 5,\n\"year\": 1977,\n\"month\": 2,\n\"day_of_month\": 25,\n\"hour\": 15,\n\"minute\": 33,\n\"calendar\": \"GREGORIAN\"\n}\n}\n]\n}\n]\n}\n}"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages"))
    .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\\"messaging_product\\": \\"whatsapp\\",\\n\\"recipient_type\\": \\"individual\\",\\n\\"to\\": \\"{{Recipient number}}\\",\\n\\"type\\": \\"template\\",\\n\\"template\\": {\\n\\"name\\": \\"template-name\\",\\n\\"language\\": {\\n\\"code\\": \\"language-and-locale-code\\"\\n},\\n\\"components\\": [\\n{\\n\\"type\\": \\"header\\",\\n\\n\\"parameters\\": [\\n{\\n\\"type\\": \\"image\\",\\n\\"image\\": {\\n\\"link\\": \\"http(s):\\n}\\n}\\n]\\n},\\n{\\n\\"type\\": \\"body\\",\\n\\"parameters\\": [\\n{\\n\\"type\\": \\"text\\",\\n\\"text\\": \\"text-string\\"\\n},\\n{\\n\\"type\\": \\"currency\\",\\n\\"currency\\": {\\n\\"fallback_value\\": \\"$100.99\\",\\n\\"code\\": \\"USD\\",\\n\\"amount_1000\\": 100990\\n}\\n},\\n{\\n\\"type\\": \\"date_time\\",\\n\\"date_time\\": {\\n\\"fallback_value\\": \\"February 25, 1977\\",\\n\\n\\"day_of_week\\": 5,\\n\\"year\\": 1977,\\n\\"month\\": 2,\\n\\"day_of_month\\": 25,\\n\\"hour\\": 15,\\n\\"minute\\": 33,\\n\\"calendar\\": \\"GREGORIAN\\"\\n}\\n}\\n]\\n}\\n]\\n}\\n}"
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages',
    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\"messaging_product\": \"whatsapp\",\n\"recipient_type\": \"individual\",\n\"to\": \"{{Recipient number}}\",\n\"type\": \"template\",\n\"template\": {\n\"name\": \"template-name\",\n\"language\": {\n\"code\": \"language-and-locale-code\"\n},\n\"components\": [\n{\n\"type\": \"header\",\n\n\"parameters\": [\n{\n\"type\": \"image\",\n\"image\": {\n\"link\": \"http(s):\n}\n}\n]\n},\n{\n\"type\": \"body\",\n\"parameters\": [\n{\n\"type\": \"text\",\n\"text\": \"text-string\"\n},\n{\n\"type\": \"currency\",\n\"currency\": {\n\"fallback_value\": \"$100.99\",\n\"code\": \"USD\",\n\"amount_1000\": 100990\n}\n},\n{\n\"type\": \"date_time\",\n\"date_time\": {\n\"fallback_value\": \"February 25, 1977\",\n\n\"day_of_week\": 5,\n\"year\": 1977,\n\"month\": 2,\n\"day_of_month\": 25,\n\"hour\": 15,\n\"minute\": 33,\n\"calendar\": \"GREGORIAN\"\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/{phone_number_id}/messages", 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/{phone_number_id}/messages", bytes.NewBufferString("{\n  \"raw_example\": \"{\\n\\\"messaging_product\\\": \\\"whatsapp\\\",\\n\\\"recipient_type\\\": \\\"individual\\\",\\n\\\"to\\\": \\\"{{Recipient number}}\\\",\\n\\\"type\\\": \\\"template\\\",\\n\\\"template\\\": {\\n\\\"name\\\": \\\"template-name\\\",\\n\\\"language\\\": {\\n\\\"code\\\": \\\"language-and-locale-code\\\"\\n},\\n\\\"components\\\": [\\n{\\n\\\"type\\\": \\\"header\\\",\\n\\n\\\"parameters\\\": [\\n{\\n\\\"type\\\": \\\"image\\\",\\n\\\"image\\\": {\\n\\\"link\\\": \\\"http(s):\\n}\\n}\\n]\\n},\\n{\\n\\\"type\\\": \\\"body\\\",\\n\\\"parameters\\\": [\\n{\\n\\\"type\\\": \\\"text\\\",\\n\\\"text\\\": \\\"text-string\\\"\\n},\\n{\\n\\\"type\\\": \\\"currency\\\",\\n\\\"currency\\\": {\\n\\\"fallback_value\\\": \\\"$100.99\\\",\\n\\\"code\\\": \\\"USD\\\",\\n\\\"amount_1000\\\": 100990\\n}\\n},\\n{\\n\\\"type\\\": \\\"date_time\\\",\\n\\\"date_time\\\": {\\n\\\"fallback_value\\\": \\\"February 25, 1977\\\",\\n\\n\\\"day_of_week\\\": 5,\\n\\\"year\\\": 1977,\\n\\\"month\\\": 2,\\n\\\"day_of_month\\\": 25,\\n\\\"hour\\\": 15,\\n\\\"minute\\\": 33,\\n\\\"calendar\\\": \\\"GREGORIAN\\\"\\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.

{
"messaging_product": "whatsapp",
"contacts": [
{
"input": "9175XXXXXXXX",
"wa_id": "9175XXXXXXXX"
}
],
"messages": [
{

"id":
"wamid.HBgMOTE3OTcyODkyNzEyFQIAERgSQzAwRDEzNkQ1NDFFNkM3NkEzAA=
="
}
]
}

{
  "type": "object",
  "properties": {
    "raw_example": {
      "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.