Connected Accounts

Enable or disable a connected account (DEPRECATED)

Changed on

DEPRECATED: We are controlling the API surface and the dependencies between endpoints, and enabling or disabling a connected account is covered by existing endpoints. To stop a connected account from being used, delete it with DELETE /api/v3/connected_accounts/{nanoid} (pass ?revoke_on_delete=true to also revoke its upstream credentials); to use the account again, create a new connection. This endpoint still works for existing integrations but may be removed in a future release. It sets the connected account to ACTIVE (enabled: true) or INACTIVE (enabled: false); inactive accounts cannot be used for API calls. Disabling an account also disables its triggers, and Composio attempts to remove their webhooks at the provider in the background.

patch/api/v3.1/connected_accounts/{nanoId}/status

Request

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

Path parameters

nanoIdstring connectedAccountId required

The unique identifier of the connected account

Request body

enabledboolean required

Set to true to enable the account or false to disable it

Example request

{
  "enabled": true
}

Response

Successfully updated the connected account status. If enabled=true, the account status is set to ACTIVE; if enabled=false, the status is set to INACTIVE.

successboolean required

Indicates whether the connected account status was successfully updated

Example response

{
  "success": true
}

Changes

    • info

      api operation id patchV3_1ConnectedAccountsByNanoIdStatus removed and replaced with patchConnectedAccountsByNanoIdStatus

    • info

      api tag Account Management removed

    • info

      endpoint deprecated

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API