Integrations
Integrations

Update per-connection user options (e.g., channel allowlist)

Changed on

Save per-user options on a connection owned by the authenticated user.

Connections outside the current app cannot be updated.

patch/integrations/{integration_id}/connections/{connection_id}

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/integrations/{integration_id}/connections/{connection_id}
  • Auth
    HTTP bearer

Path parameters

integration_idstring required
connection_idstring required

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

channelsstring[] nullable

Channel/chat IDs to index. For required-selection integrations (Teams) an empty list blocks all; for optional-selection integrations (Slack) an empty list indexes all. Deselected channels' indexed data is purged.

shown_channel_idsstring[] nullable

IDs of every channel/chat the caller displayed when this selection was made, at all levels of a hierarchical listing. Where selection is optional, only a displayed channel left out of channels has its indexed data purged; channels that were not displayed keep theirs. Omit to fall back to the most recent channel listing served for the connection.

Response

Successful Response

channelsstring[]

Changes