List WhatsApp templates

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_templates \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "template-123abc",
      "name": "appointment_reminder",
      "language_code": "en_US",
      "category": "UTILITY",
      "status": "approved",
      "content": "Hello {{1}}, your appointment is confirmed for {{2}}.",
      "parameter_count": 2,
      "business_account_id": "123456789012345",
      "whatsapp_config_ids": [
        "config-123abc",
        "config-456def"
      ],
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "<string>",
          "example": {},
          "buttons": [
            {}
          ]
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

GET

whatsapp_templates

List WhatsApp templates

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_templates \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "template-123abc",
      "name": "appointment_reminder",
      "language_code": "en_US",
      "category": "UTILITY",
      "status": "approved",
      "content": "Hello {{1}}, your appointment is confirmed for {{2}}.",
      "parameter_count": 2,
      "business_account_id": "123456789012345",
      "whatsapp_config_ids": [
        "config-123abc",
        "config-456def"
      ],
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "<string>",
          "example": {},
          "buttons": [
            {}
          ]
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key

string

header

required

API key required for all endpoints

Query Parameters

page

integer

default:1

Required range: x >= 1

per_page

integer

default:20

Required range: 1 <= x <= 100

customer_id

string<uuid>

Filter templates by customer ID

q[name_cont]

string

Filter templates by name (contains)

q[language_code_eq]

string

Filter templates by exact language code match

q[category_eq]

enum<string>

Filter templates by category

Available options:

MARKETING,

UTILITY,

AUTHENTICATION

q[status_eq]

enum<string>

Filter templates by status

Available options:

draft,

submitted,

approved,

rejected,

disabled

q[customer_id_eq]

string<uuid>

Filter templates by customer ID (Ransack syntax)

business_account_id

string

Filter templates by WhatsApp Business Account ID

q[business_account_id_eq]

string

Filter templates by WhatsApp Business Account ID (Ransack syntax)

whatsapp_config_id

string<uuid>

Filter templates by WhatsApp configuration ID

q[whatsapp_config_id_eq]

string<uuid>

Filter templates by WhatsApp configuration ID (Ransack syntax)

Response

A list of WhatsApp templates

data

object[]

Show child attributes

Guides

WhatsApp Conversations

WhatsApp Messages

Conversation Assignments

WhatsApp Templates

WhatsApp Contacts

WhatsApp Contact Notes

WhatsApp Configs

WhatsApp Calls

WhatsApp Contact Call Permissions

List WhatsApp templates

Authorizations

Query Parameters

Response