Create setup link

Generate an onboarding setup for customers to connect their WhatsApp number.

Open the returned URL as a Kapso-hosted page, or use the returned token with @kapso/sdk when your Tech Provider app belongs to an active Kapso Multi-partner Solution. The setup can optionally provision a new number.

POST /customers/{customer_id}/setup_links

cURL

minimal

curl --request POST \
  --url https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "setup_link": {}
}
'

201

{
  "data": {
    "id": "7f8a9b1c-2d3e-4f5a-6b7c-8d9e0f1a2b3c",
    "status": "active",
    "created_at": "2025-01-15T10:00:00Z",
    "expires_at": "2025-02-14T10:00:00Z",
    "url": "https://app.kapso.ai/whatsapp/setup/aBcD123xyz456def789",
    "token": "aBcD123xyz456def789",
    "success_redirect_url": "https://yourapp.com/whatsapp/success",
    "failure_redirect_url": "https://yourapp.com/whatsapp/failed",
    "allowed_origins": [
      "https://app.example.com"
    ],
    "allowed_connection_types": [
      "coexistence",
      "dedicated"
    ],
    "meta_billing_mode": "customer_managed",
    "provision_phone_number": false,
    "phone_number_area_code": null,
    "phone_number_country_isos": [
      "US"
    ],
    "reconnect_phone_number": null,
    "theme_config": {
      "primary_color": "#3b82f6",
      "primary_foreground_color": "#ffffff",
      "background_color": "#f9fafb",
      "text_color": "#111827",
      "border_color": "#d1d5db"
    },
    "whatsapp_setup_status": "pending",
    "whatsapp_setup_error": null
  }
}

Authorizations

X-API-Key · string · header · required

Path Parameters

customer_id · string<uuid> · required

Body

application/json

setup_link · object · required

Show child attributes

Response

201

application/json

Setup link created

data · object · required

Show child attributes