API ReferenceConnected Accounts

Enable or disable a connected account

Markdown
PATCH
/api/v3/connected_accounts/{nanoId}/status

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.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

nanoId*string

The unique identifier of the connected account

FormatconnectedAccountId

Request Body

application/json

enabled*boolean

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

curl -X PATCH "https://backend.composio.dev/api/v3/connected_accounts/con_1a2b3c4d5e6f/status" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{
  "success": true
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}