Sign in

v63

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-08-0110571.8 MB
Connected Accounts
Account Management

Delete a connected account

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.

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

Path parameters

nanoidstring connectedAccountId required

The unique identifier (nanoid) of the connected account

Query parameters

revoke_on_deleteboolean nullable

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.

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.

Response

Successfully deleted the connected account. The account is marked as deleted but retained in the database for historical purposes.

successboolean required

Indicates whether the connected account was successfully deleted

revoke_job_idstring

Identifier of the background revoke job started for this delete. Present only when revoke_on_delete=true. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.

Example response

{
  "success": true
}