Broadcasts
Add recipients
Add up to 1000 recipients to a draft broadcast. Duplicates are skipped.
Recipients use Meta’s component syntax with body, header, and button components.
POST
/
whatsapp
/
broadcasts
/
{broadcast_id}
/
recipients
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"whatsapp_broadcast": {
"recipients": [
{
"phone_number": "+14155550123",
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "John"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE50"
}
]
}
]
},
{
"phone_number": "+14155550124",
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Jane"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE40"
}
]
}
]
}
]
}
}
'{
"data": {
"added": 495,
"duplicates": 5,
"errors": [
"Recipient 3: template parameters invalid - requires 2 parameters but got 1",
"Recipient 7: invalid phone number format"
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Was this page helpful?
⌘I
curl --request POST \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"whatsapp_broadcast": {
"recipients": [
{
"phone_number": "+14155550123",
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "John"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE50"
}
]
}
]
},
{
"phone_number": "+14155550124",
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Jane"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE40"
}
]
}
]
}
]
}
}
'{
"data": {
"added": 495,
"duplicates": 5,
"errors": [
"Recipient 3: template parameters invalid - requires 2 parameters but got 1",
"Recipient 7: invalid phone number format"
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}