Connected Accounts

Delete a connected account

Deletes the account and the credentials Scalekit stores for it. It doesn't revoke the user's grant at the app. Identify the account by ID, or by its connector and identifier. This can't be undone.

post/api/v1/connected_accounts:delete

Request

Base URL
https://$SCALEKIT_ENVIRONMENT_URL
Auth
OAuth 2
Client credentials
Token URLhttps://$SCALEKIT_ENVIRONMENT_URL/oauth/token
TypeScript
https://skmtc.dev/scalekit/apis/scalekit-api-reference/docs/api/v1/connected_accounts:delete/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

connectorstring

Connector identifier (e.g., 'notion', 'slack', 'google'). Alphanumeric characters, spaces, hyphens, underscores, and colons are allowed.

idstring

Unique identifier for the connected account to delete

identifierstring

The unique identifier for the connected account within the third-party service (e.g., email address, user ID, workspace identifier).

organization_idstring

An organization ID to key the account by instead of identifier, such as a Scalekit organization ID. Ignored when identifier is set.

user_idstring

A user ID that, with organization_id, keys the account to one user in that organization. Ignored when identifier is set.

Example request

{
  "connector": "notion",
  "id": "ca_123",
  "identifier": "user@example.com",
  "organization_id": "org_121312434123312",
  "user_id": "user_121312434123312"
}

Response

Connected account deleted, with the credentials Scalekit stored for it

unknown required

Changes

No recorded changes to this operation across all 16 revisions of this API.