Delete Template by name and id · WhatsApp

infoOverview

About this API

This API is used to delete the template by its name and id

MethodDELETE

Versionv3.0

Base URLhttps://partnersv1.pinbot.ai/v3

Content TypeNo request body

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.

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

namestringNot specifiedRequest value for name.

hsm_idstringNot specifiedRequest value for hsm id.

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

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 DELETE 'https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D' \
  --header 'apikey: <API_KEY>'

const response = await fetch('https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D', {
  method: 'DELETE',
  headers: {
    "apikey": "<API_KEY>"
  },
});

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?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D', {
  method: 'DELETE',
  headers: {
    "apikey": "<API_KEY>"
  },
});

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?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D'
headers = {
  "apikey": "<API_KEY>"
}
response = requests.delete(url, headers=headers)

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();
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D"))
    .header("apikey", "<API_KEY>")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => ["apikey: <API_KEY>"],
]);
$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 response = await client.DeleteAsync("https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("DELETE", "https://partnersv1.pinbot.ai/v3/{wabaid}/message_templates?name=%7Btemplatename%7D&hsm_id=%7Bmessagetemplateid%7D", nil)
    if err != nil { panic(err) }
    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": {
    "success": true
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}

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.