Enable or disable a connected account

Updates the status of a connected account to either enabled (active) or disabled (inactive). Disabled accounts cannot be used for API calls but remain in the database.

Path parameters

nanoIdstringRequiredformat: "connectedAccountId"

The unique identifier of the connected account

Request

This endpoint expects an object.

enabledbooleanRequired

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

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

Indicates whether the connected account status was successfully updated

1	import requests
2
3	url = "https://backend.composio.dev/api/v3/connected_accounts/con_1a2b3c4d5e6f/status"
4
5	payload = { "enabled": True }
6	headers = {
7	"x-api-key": "<x-api-key>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.patch(url, json=payload, headers=headers)
12
13	print(response.json())

Path parameters

Headers

Request

Response