Skip to main content
PATCH
/
whatsapp
/
broadcasts
/
{broadcast_id}
curl --request PATCH \
  --url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_broadcast": {
    "status": "stopped"
  }
}
'
{
  "data": {
    "id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
    "name": "Weekend Sale 2025",
    "status": "stopped",
    "scheduled_at": null,
    "started_at": "2025-07-15T10:00:00Z",
    "stopped_at": "2025-07-15T10:12:30Z",
    "completed_at": null,
    "created_at": "2025-07-14T15:00:00Z",
    "updated_at": "2025-07-15T10:12:30Z",
    "phone_number_id": "1234567890",
    "whatsapp_template": null,
    "total_recipients": 1000,
    "sent_count": 650,
    "failed_count": 50,
    "delivered_count": 600,
    "read_count": 320,
    "responded_count": 45,
    "pending_count": 300,
    "response_rate": 6.9
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
broadcast_id
string<uuid>
required

Body

application/json
​
whatsapp_broadcast
object
required

Response

OK

​
data
object
required