Skip to main content

​
Prerequisites

To get the most out of this guide, you’ll need to:

​
1. Get your credentials

Get your API key and phone number ID from the dashboard. 
export KAPSO_API_KEY="your_api_key"
export PHONE_NUMBER_ID="your_phone_number_id"

​
2. Send a message

The easiest way to send a message is with a simple POST request.
curl
curl -X POST https://api.kapso.ai/meta/whatsapp/${PHONE_NUMBER_ID}/messages \
  -H "X-API-Key: ${KAPSO_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "1234567890",
    "type": "text",
    "text": {
      "preview_url": false,
      "body": "Hello from Kapso!"
    }
  }'

​
BSUID note

Kapso currently keeps outbound sends phone-based. Keep sending to with the recipient phone number. Inbound payloads and read surfaces can already expose BSUID fields and nullable phone identity. If you also consume webhooks or read message/conversation/contact payloads, see the migration guide:

​
3. Try it yourself

WhatsApp API reference

See all available endpoints.