Sign in
Connected Accounts
Account Management

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.

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

Path parameters

nanoIdstring connectedAccountId required

The unique identifier of the connected account

Request body

enabledboolean required

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

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.

successboolean required

Indicates whether the connected account status was successfully updated

Example response

{
  "success": true
}

Changes

Changed in 3 of the 61 revisions of this API.3