The Platform API lets your customers connect their own WhatsApp Business accounts to your application.

​
Use cases

  • Healthcare platforms: Clinics use their own WhatsApp for appointment reminders
  • E-commerce platforms: Stores send order updates from their WhatsApp number
  • CRM systems: Sales teams message leads from company WhatsApp
  • Support tools: Customer service on the business’s WhatsApp

​
How it works

// 1. Create a customer
const customer = await fetch('https://app.kapso.ai/api/v1/customers', {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  body: JSON.stringify({
    customer: {
      name: 'Acme Corporation',
      external_customer_id: 'customer-123'
    }
  })
});

// 2. Generate setup link
const setupLink = await fetch(`https://app.kapso.ai/api/v1/customers/${customerId}/setup_links`, {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});

// 3. Customer clicks link and connects WhatsApp
// Share setupLink.data.url with your customer

// 4. Send messages on their behalf
const message = await fetch('https://app.kapso.ai/api/v1/whatsapp_messages', {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  body: JSON.stringify({
    customer_id: customerId,  // Or use whatsapp_config_id for specific config
    message: {
      phone_number: '+1234567890',
      content: 'Your appointment is tomorrow at 2 PM'
    }
  })
});

​
Connection types

Coexistence - Customer keeps using WhatsApp Business app
  • 5 messages per second
  • App and API work together
  • Requires active WhatsApp Business app
Dedicated - API-only access
  • Up to 1000 messages per second
  • Full automation control
  • No WhatsApp Business app

​
Sending messages

When sending WhatsApp messages, use either:
  • customer_id - Uses the customer’s default WhatsApp configuration
  • whatsapp_config_id - Uses a specific WhatsApp configuration (when customer has multiple numbers)

​
Authentication

All endpoints require your API key in the X-API-Key header. 
curl -H "X-API-Key: YOUR_API_KEY" \
  https://app.kapso.ai/api/v1/customers

​
Rate limits

  • 1000 requests per minute per API key
  • 10 setup link creations per customer per hour