Enable or disable a connected account (DEPRECATED)
Changed onDEPRECATED: 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.
Request
- Base URLhttps://backend.composio.dev
- URLhttps://backend.composio.dev/api/v3.1/connected_accounts/{nanoId}/status
- AuthAPI key in header x-api-key
Path parameters
The unique identifier of the connected account
Request body
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.
Example response
{
"success": true
}Changes
- info
api operation id
patchV3_1ConnectedAccountsByNanoIdStatusremoved and replaced withpatchConnectedAccountsByNanoIdStatus - info
api tag
Account Managementremoved - info
endpoint deprecated
- info
added the non-success response with the status
- info
added the required property
to the response with the status
- info
- info
the endpoint scheme security
UserApiKeyAuthwas removed from the API
- info