Send Authentication Template Message · WhatsApp

infoOverview

About this API

This API is used to send an authentication template message.

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.

phone_number_idstringRequiredResource identifier for phone number id.

uploadInput

Request Body

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

Top-Level Fields

tostringNot specifiedRequest value for to.

typestringNot specifiedRequest value for type.

templateobjectNot specifiedRequest value for template.

recipient_typestringNot specifiedRequest value for recipient type.

messaging_productstringNot specifiedRequest value for messaging product.

{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "template": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "language": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            }
          }
        },
        "components": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "parameters": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "text": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "recipient_type": {
      "type": "string"
    },
    "messaging_product": {
      "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.

WABA ID WABA number Recipient

Request body application/json

Edit the documented request body, then test it in the phone preview.

9:41⌁

chevron_left

1SPOC Demobusiness account

videocamcall

lockMessages are end-to-end encrypted. This preview is simulated.

Today

Ready to preview: Send Authentication Template Message.9:41

add_circle

Messagedescription

photo_cameramic

codeIntegration

Code Examples

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

Request URL

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 '{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}'

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({
    "to": "{{recipient_no}}",
    "type": "template",
    "template": {
      "name": "zero_tap_ttt_vk_fff",
      "language": {
        "code": "en_US"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "text": "84984519",
              "type": "text"
            }
          ]
        },
        {
          "type": "button",
          "index": "0",
          "sub_type": "url",
          "parameters": [
            {
              "text": "8498451119",
              "type": "text"
            }
          ]
        }
      ]
    },
    "recipient_type": "individual",
    "messaging_product": "whatsapp"
  })
});

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({
    "to": "{{recipient_no}}",
    "type": "template",
    "template": {
      "name": "zero_tap_ttt_vk_fff",
      "language": {
        "code": "en_US"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "text": "84984519",
              "type": "text"
            }
          ]
        },
        {
          "type": "button",
          "index": "0",
          "sub_type": "url",
          "parameters": [
            {
              "text": "8498451119",
              "type": "text"
            }
          ]
        }
      ]
    },
    "recipient_type": "individual",
    "messaging_product": "whatsapp"
  })
});

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'''{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}''')
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 = """
{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}
""";
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 = '{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}';
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 = """
{
  "to": "{{recipient_no}}",
  "type": "template",
  "template": {
    "name": "zero_tap_ttt_vk_fff",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "text": "84984519",
            "type": "text"
          }
        ]
      },
      {
        "type": "button",
        "index": "0",
        "sub_type": "url",
        "parameters": [
          {
            "text": "8498451119",
            "type": "text"
          }
        ]
      }
    ]
  },
  "recipient_type": "individual",
  "messaging_product": "whatsapp"
}
""";
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  \"to\": \"{{recipient_no}}\",\n  \"type\": \"template\",\n  \"template\": {\n    \"name\": \"zero_tap_ttt_vk_fff\",\n    \"language\": {\n      \"code\": \"en_US\"\n    },\n    \"components\": [\n      {\n        \"type\": \"body\",\n        \"parameters\": [\n          {\n            \"text\": \"84984519\",\n            \"type\": \"text\"\n          }\n        ]\n      },\n      {\n        \"type\": \"button\",\n        \"index\": \"0\",\n        \"sub_type\": \"url\",\n        \"parameters\": [\n          {\n            \"text\": \"8498451119\",\n            \"type\": \"text\"\n          }\n        ]\n      }\n    ]\n  },\n  \"recipient_type\": \"individual\",\n  \"messaging_product\": \"whatsapp\"\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=
="
}
]
}

Business APIs Batch -3 (PARTNERS)

{
  "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.