API ReferenceConnected Accounts

Enable or disable a connected accountv3.1

PATCH
/api/v3.1/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>

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

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