Connected Accounts

Delete a connected account

Changed on

Deletes a connected account. The account immediately stops working for API calls and cannot be restored through the API. Pass ?revoke_on_delete=true to also revoke the account's upstream credentials.

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

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/connected_accounts/{nanoid}
  • Auth
    • API key in header x-api-key
    • or API key in header x-user-api-key

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.

Response

Successfully deleted the connected account.

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
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id deleteV3_1ConnectedAccountsByNanoid removed and replaced with deleteConnectedAccountsByNanoid

    • info

      api tag Account Management removed

    • info

      added the required property to the response with the status

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      added the new optional query request parameter revoke_on_delete

    • info

      added the optional property to the response with the status