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"
  }
}
'

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