Update setup link

Update an existing setup link’s configuration. Can be used to modify redirect URLs, theme settings, connection types, status, or expiration.

PATCH /customers/{customer_id}/setup_links/{id}

cURL

update_redirects

curl --request PATCH \
  --url https://app.kapso.ai/api/v1/customers/{customer_id}/setup_links/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "setup_link": {
    "success_redirect_url": "https://your-app.com/new-success",
    "failure_redirect_url": "https://your-app.com/new-failure"
  }
}
'

200

updated

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

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

customer_id · string<uuid> · required

id · string<uuid> · required

Setup link ID

Body

application/json

setup_link · object

Show child attributes

Response

200

application/json

Setup link updated successfully

data · object

Show child attributes