API ReferenceConnected Accounts

Delete a connected accountv3.1

DELETE
/api/v3.1/connected_accounts/{nanoid}

Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes. Pass ?revoke_on_delete=true to also revoke the account's upstream credentials via a background job.

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

The unique identifier (nanoid) of the connected account

Format: connectedAccountId

Query Parameters

revoke_on_deletenullable boolean

When true, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a revoke_job_id. Defaults to false. Revocation is irreversible — recovering a deleted entity does not restore working credentials.

Default: false

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v3.1/connected_accounts/ca_1a2b3c4d5e6f"
{  "success": true}
Edit this page on GitHub