Connections
Connections

Revoke connection

Revoke Hyperspell's access to a provider and delete this user's stored data.

Revocation and deletion are processed asynchronously, so the endpoint returns 202 Accepted immediately. Repeated requests for the same app, user, and provider are safe.

delete/connections/{connection_id}/revoke

Request

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

Path parameters

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

Response

Successful Response

successboolean required
messagestring required

Changes

No operation changes recorded.