API ReferenceConnected Accounts

Enable or disable a connected accountv3.1Legacy

Deprecated

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

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.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoIdstringRequired

The unique identifier of the connected account

Format: connectedAccountId

Request Body

application/json

enabledbooleanRequired

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v3.1/connected_accounts/ca_1a2b3c4d5e6f/status" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{  "success": true}
Edit this page on GitHub