PUT

/api/v1/exchanges/:id

Permission: EXCHANGES_WRITESecurity: SIGNED

Updates an exchange account configuration using its unique ID, including updating API keys, secret credentials, label name, and active connection status.

Body Parameters

labelstring

Updated custom name or label for this exchange account.

api_keystring

Updated API key from this exchange account (re-encrypted with AES-256-GCM).

api_secretstring

Updated API secret from this exchange account.

passphrasestring

Updated API passphrase for exchanges requiring it (e.g. OKX).

is_activeboolean

Enable (true) or disable (false) automated bot trading on this connection.

Example Request

edit_account_request.json
PUT /api/v1/exchanges/:id
{
  "label": "My Renamed Binance Account",
  "api_key": "x9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4",
  "api_secret": "9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c",
  "is_active": true
}

Response Parameters

Account Entity Structure

If successful, the response includes the full updated copy of the Exchange Connection model.

View Account Entity Spec

Example Responses

edit_account_200.json
200 OK
{
  "id": "7fa84b80-77a8-4e89-a292-123456789abc",
  "exchange": "binance",
  "label": "My Renamed Binance Account",
  "connection_type": "spot",
  "can_trade": true,
  "can_withdraw": false,
  "is_active": true,
  "is_testnet": false,
  "last_verified": "2026-08-20T23:31:00.000Z",
  "last_error": null,
  "created_at": "2026-08-20T23:25:00.000Z"
}