Delete a connected account

POST/api/v1/connected_accounts:delete

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.

This page as markdown Connected accounts overview

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

Body

connectorstring

The connection name, as shown in AgentKit > Connections.

idstring

Unique identifier for the connected account to delete

identifierstring

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

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.

scalekit_client.actions.delete_connected_account

Delete a connected account

scalekit_client.actions.delete_connected_account(
    connection_name: Optional[str] = None,
    identifier: Optional[str] = None,
    connected_account_id: Optional[str] = None,
) -> DeleteConnectedAccountResponse

Parameters

connection_nameOptional[str]

The connection name, as shown in AgentKit > Connections.

identifierOptional[str]

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

connected_account_idOptional[str]

Connected account ID

Returns DeleteConnectedAccountResponse: An empty response.

From scalekit-sdk-python 2.19.1.

scalekit.actions.deleteConnectedAccount

Delete a connected account. Requires either connectedAccountId or both connectionName + identifier.

scalekit.actions.deleteConnectedAccount(
  params: {
    connectionName?: string;
    identifier?: string;
    connectedAccountId?: string;
    organizationId?: string;
    userId?: string;
  },
): Promise<DeleteConnectedAccountResponse>

Parameters

connectionNamestring

The connection name, as shown in AgentKit > Connections.

identifierstring

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

connectedAccountIdstring

Unique identifier for the connected account to delete

organizationIdstring

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

userIdstring

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

Returns Promise<DeleteConnectedAccountResponse>.

From @scalekit-sdk/node 2.18.0.

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request - malformed parameters or validation failed. Error code MCP_SERVER_EXISTS_FOR_CONNECTED_ACCOUNT when a Virtual MCP server instance for this user still uses the account; delete that Virtual MCP server first.

401Authentication required - missing or invalid access token

404Connected account not found - the specified account does not exist

Used in

Manage connected accounts

Request

curl -sS -X POST \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/connected_accounts:delete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connector": "gmail",
    "identifier": "user_123"
  }'

result = scalekit_client.actions.delete_connected_account(
    connection_name="gmail",
    identifier="user_123",
)

const result = await scalekit.actions.deleteConnectedAccount({
  connectionName: "gmail",
  identifier: "user_123",
});