Create broadcast

Create a draft WhatsApp broadcast tied to a production WhatsApp config and template.

Requirements:

• WhatsApp config must be production type
• Template must be approved and linked to the config

POST /whatsapp_broadcasts

Create broadcast

cURL

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_broadcasts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_broadcast": {
    "name": "July Promo",
    "whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
    "whatsapp_template_id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
  }
}
'

import requests

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

payload = { "whatsapp_broadcast": {
        "name": "July Promo",
        "whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
        "whatsapp_template_id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    whatsapp_broadcast: {
      name: 'July Promo',
      whatsapp_config_id: '4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d',
      whatsapp_template_id: '7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d'
    }
  })
};

fetch('https://app.kapso.ai/api/v1/whatsapp_broadcasts', 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_broadcasts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'whatsapp_broadcast' => [
        'name' => 'July Promo',
        'whatsapp_config_id' => '4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d',
        'whatsapp_template_id' => '7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"whatsapp_broadcast\": {\n    \"name\": \"July Promo\",\n    \"whatsapp_config_id\": \"4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d\",\n    \"whatsapp_template_id\": \"7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.kapso.ai/api/v1/whatsapp_broadcasts")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"whatsapp_broadcast\": {\n    \"name\": \"July Promo\",\n    \"whatsapp_config_id\": \"4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d\",\n    \"whatsapp_template_id\": \"7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"whatsapp_broadcast\": {\n    \"name\": \"July Promo\",\n    \"whatsapp_config_id\": \"4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d\",\n    \"whatsapp_template_id\": \"7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d\"\n  }\n}"

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

201

Example

{
  "data": {
    "id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
    "name": "July Promo",
    "status": "draft",
    "started_at": "2025-07-15T10:00:00Z",
    "completed_at": "2025-07-15T11:30:00Z",
    "created_at": "2025-07-14T15:00:00Z",
    "updated_at": "2025-07-15T11:30:00Z",
    "whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
    "whatsapp_template": {
      "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
      "name": "july_promo_template",
      "language_code": "en_US",
      "category": "MARKETING",
      "status": "approved"
    },
    "total_recipients": 123,
    "sent_count": 100,
    "failed_count": 23,
    "delivered_count": 90,
    "read_count": 75,
    "responded_count": 12,
    "pending_count": 0,
    "response_rate": 12,
    "stats": {
      "total": 123,
      "sent": 100,
      "failed": 23,
      "delivered": 90,
      "read": 75,
      "responded": 12,
      "pending": 0
    }
  }
}

Authorizations

X-API-Key · string · header · required

Your project API key

Body

application/json

whatsapp_broadcast · object · required

Show child attributes

Response

201

application/json

Broadcast created successfully

data · object

WhatsApp broadcast campaign

Show child attributes