Create Authentication Copy Code Template · WhatsApp

infoOverview

About this API

This API is used to create a copy code authentication template.

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.

wabaidstringRequiredResource identifier for wabaid.

uploadInput

Request Body

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

Top-Level Fields

namestringNot specifiedRequest value for name.

categorystringNot specifiedRequest value for category.

languagestringNot specifiedRequest value for language.

componentsarrayNot specifiedRequest value for components.

message_send_ttl_secondsintegerNot specifiedRequest value for message send ttl seconds.

{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "language": {
      "type": "string"
    },
    "components": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "add_security_recommendation": {
            "type": "boolean"
          }
        }
      }
    },
    "message_send_ttl_seconds": {
      "type": "integer"
    }
  }
}

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/{wabaid}/message_templates' \
  --header 'apikey: <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}'

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({
    "name": "copycode_noexp_2111",
    "category": "authentication",
    "language": "en_US",
    "components": [
      {
        "type": "body",
        "add_security_recommendation": true
      },
      {
        "type": "footer",
        "code_expiration_minutes": 5
      },
      {
        "type": "buttons",
        "buttons": [
          {
            "text": "Copy Code",
            "type": "otp",
            "otp_type": "copy_code"
          }
        ]
      }
    ],
    "message_send_ttl_seconds": 60
  })
});

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({
    "name": "copycode_noexp_2111",
    "category": "authentication",
    "language": "en_US",
    "components": [
      {
        "type": "body",
        "add_security_recommendation": true
      },
      {
        "type": "footer",
        "code_expiration_minutes": 5
      },
      {
        "type": "buttons",
        "buttons": [
          {
            "text": "Copy Code",
            "type": "otp",
            "otp_type": "copy_code"
          }
        ]
      }
    ],
    "message_send_ttl_seconds": 60
  })
});

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'''{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}''')
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 = """
{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}
""";
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 = '{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}';
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 = """
{
  "name": "copycode_noexp_2111",
  "category": "authentication",
  "language": "en_US",
  "components": [
    {
      "type": "body",
      "add_security_recommendation": true
    },
    {
      "type": "footer",
      "code_expiration_minutes": 5
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "text": "Copy Code",
          "type": "otp",
          "otp_type": "copy_code"
        }
      ]
    }
  ],
  "message_send_ttl_seconds": 60
}
""";
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  \"name\": \"copycode_noexp_2111\",\n  \"category\": \"authentication\",\n  \"language\": \"en_US\",\n  \"components\": [\n    {\n      \"type\": \"body\",\n      \"add_security_recommendation\": true\n    },\n    {\n      \"type\": \"footer\",\n      \"code_expiration_minutes\": 5\n    },\n    {\n      \"type\": \"buttons\",\n      \"buttons\": [\n        {\n          \"text\": \"Copy Code\",\n          \"type\": \"otp\",\n          \"otp_type\": \"copy_code\"\n        }\n      ]\n    }\n  ],\n  \"message_send_ttl_seconds\": 60\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": "AUTHENTICATION"
  }
}

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