Add recipients (batch)

Bulk-add recipients to a draft broadcast.

Constraints:

• Accepts up to 1,000 recipients per request
• Broadcast must be in draft status
• Phone numbers are normalized to E.164 format without + prefix

Template Parameters:

• Array format for positional parameters: ["Param1", "Param2"]
• Object format for named parameters with support for media headers:

  {
    "first_name": "Alicia",
    "discount_code": "JULY25",
    "header_url": "https://example.com/image.jpg",
    "header_filename": "promo.jpg"
  }
  

POST /whatsapp_broadcasts/{broadcast_id}/recipients

cURL

positional_params

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}/recipients \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "recipients": [
    {
      "phone_number": "[phone]",
      "template_parameters": [
        "John",
        "50% off"
      ]
    },
    {
      "phone_number": "[phone]",
      "template_parameters": [
        "Jane",
        "40% off"
      ]
    }
  ]
}
'

201

all_success

{
  "data": {
    "added": 500,
    "duplicates": 0,
    "errors": []
  }
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

broadcast_id · string<uuid> · required

Body

application/json

recipients · object[] · required

Maximum array length: 1000

Show child attributes

Response

201

application/json

Recipients added (with summary of successes/failures)

data · object

Response from batch recipient add operation

Show child attributes