Authorizations
Path Parameters
Body
application/json
Response
Setup link created
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": {}
}'{
"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",
"success_redirect_url": "https://yourapp.com/whatsapp/success",
"failure_redirect_url": "https://yourapp.com/whatsapp/failed",
"allowed_connection_types": [
"coexistence",
"dedicated"
],
"provision_phone_number": false,
"phone_number_area_code": null,
"phone_number_country_isos": [
"US"
],
"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
}
}Generate a hosted onboarding page for customers to connect their WhatsApp number.
The link guides them through Meta’s embedded signup and optionally provisions a new number.
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": {}
}'{
"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",
"success_redirect_url": "https://yourapp.com/whatsapp/success",
"failure_redirect_url": "https://yourapp.com/whatsapp/failed",
"allowed_connection_types": [
"coexistence",
"dedicated"
],
"provision_phone_number": false,
"phone_number_area_code": null,
"phone_number_country_isos": [
"US"
],
"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
}
}Show child attributes
Setup link created
Show child attributes
Was this page helpful?