Authorizations
Body
application/json
Response
Created
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"whatsapp_broadcast": {
"name": "Weekend Sale 2025",
"phone_number_id": "1234567890",
"whatsapp_template_id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
}
}'{
"data": {
"id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"name": "Weekend Sale 2025",
"status": "draft",
"started_at": null,
"completed_at": null,
"created_at": "2025-07-14T15:00:00Z",
"updated_at": "2025-07-14T15:00:00Z",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"phone_number_id": "1234567890",
"whatsapp_template": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"name": "weekend_sale_2025",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"total_recipients": 0,
"sent_count": 0,
"failed_count": 0,
"delivered_count": 0,
"read_count": 0,
"responded_count": 0,
"pending_count": 0,
"response_rate": 0
}
}Create a broadcast campaign in draft mode.
Workflow: create broadcast → add recipients → send. Broadcasts stay in draft until you call the send endpoint.
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"whatsapp_broadcast": {
"name": "Weekend Sale 2025",
"phone_number_id": "1234567890",
"whatsapp_template_id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d"
}
}'{
"data": {
"id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
"name": "Weekend Sale 2025",
"status": "draft",
"started_at": null,
"completed_at": null,
"created_at": "2025-07-14T15:00:00Z",
"updated_at": "2025-07-14T15:00:00Z",
"whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
"phone_number_id": "1234567890",
"whatsapp_template": {
"id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
"name": "weekend_sale_2025",
"language_code": "en_US",
"category": "MARKETING",
"status": "approved"
},
"total_recipients": 0,
"sent_count": 0,
"failed_count": 0,
"delivered_count": 0,
"read_count": 0,
"responded_count": 0,
"pending_count": 0,
"response_rate": 0
}
}Show child attributes
Created
Show child attributes
Was this page helpful?