Create setup link

Generate a setup link for customer WhatsApp onboarding. Creating a new link automatically revokes any existing active links. Links expire after 30 days.

POST /customers/{customer_id}/setup_links

cURL

minimal

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

201

{
  "data": {
    "id": "7f8a9b1c-2d3e-4f5a-6b7c-8d9e0f1a2b3c",
    "status": "active",
    "expires_at": "2024-03-15T10:00:00Z",
    "url": "https://app.kapso.ai/whatsapp/setup/aBcD123xyz456def789",
    "success_redirect_url": "https://your-app.com/whatsapp/success",
    "failure_redirect_url": "https://your-app.com/whatsapp/failed",
    "allowed_connection_types": [
      "coexistence",
      "dedicated"
    ],
    "theme_config": {},
    "created_at": "2024-02-15T10:00:00Z"
  }
}

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

customer_id · string<uuid> · required

Body

application/json

setup_link · object

Show child attributes

Response

201

application/json

Setup link created

data · object

Show child attributes