Skip to main content
PATCH
/
integrations
/
{integration_id}
/
connections
/
{connection_id}
Update per-connection user options (e.g., channel allowlist)
curl --request PATCH \
  --url https://api.hyperspell.com/integrations/{integration_id}/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channels": [
    "<string>"
  ]
}
'
{
  "channels": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperspell.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

integration_id
string
required
connection_id
string
required

Body

application/json
channels
string[] | null

Channel/chat IDs to index. Empty list blocks all.

Response

Successful Response

Per-connection, per-user options set by the end user after OAuth.

Contrast with IntegrationConfig.index_options which is app-wide. These values live on the specific Connection because they depend on the tenant (e.g., which Teams channels this user wants indexed).

channels
string[]