Edit exchange account

POST

/ver1/accounts/update

Permission: ACCOUNTS_WRITE

Security: SIGNED

Updates an exchange account using its ID, including updating API keys for reconnecting the account.

---

Body Parameters

account_idintegerrequired

Unique 3Commas ID of this exchange account entity.

namestring

Name of this exchange account.

api_keystring

API-key from this exchange account.

secretstring

Secret-key from this exchange account.

customer_idstring

Unique customer ID provided by the Bitstamp exchange.

passphrasestring

Secret phrase from this exchange account. Required for OKX, Kucoin, Bitget.

addressstring

Address of wallet.

include_in_summaryboolean

Indicates whether this account should be included in the summary statistics true or not false.

Use the Supported markets list endpoint to check the required parameters: api_key, secret, address, customer_id, passphrase in the form_fields.required block in this request for selecting an exchange.

Example Request

POST

/ver1/accounts/update

{
  "account_id": 12345678,
  "api_key": "...",
  "secret": "..."
}

Response Parameters

If successful, the response includes a copy of Account entity.

Example Response

201 Created

{
  "id": 12345678,
  "auto_balance_period": 12,
  "auto_balance_portfolio_id": null,
  "auto_balance_currency_change_limit": null,
  "autobalance_enabled": false,
  "hedge_mode_available": false,
  "hedge_mode_enabled": false,
  "is_locked": false,
  "smart_trading_supported": true,
  "smart_selling_supported": true,
  "available_for_trading": {},
  "stats_supported": true,
  "trading_supported": true,
  "market_buy_supported": true,
  "market_sell_supported": true,
  "conditional_buy_supported": true,
  "bots_allowed": true,
  "bots_ttp_allowed": true,
  "bots_tsl_allowed": true,
  "gordon_bots_available": true,
  "multi_bots_allowed": true,
  "created_at": "2024-08-29T14:16:10.830Z",
  "updated_at": "2024-09-12T21:17:05.627Z",
  "last_auto_balance": null,
  "fast_convert_available": true,
  "grid_bots_allowed": true,
  "api_key_invalid": false,
  "market_icon": "https://3commas.io/img/exchanges/bybit.png",
  "deposit_enabled": false,
  "include_in_summary": true,
  "supported_market_types": [
    "spot"
  ],
  "primary_display_currency_profit_percentage": {
    "currency": "USD",
    "amount": "1.27"
  },
  "primary_display_currency_profit": {
    "currency": "USD",
    "amount": "0.41977392126027012455593960354579615351317609077582"
  },
  "day_profit_primary_display_currency_percentage": {
    "currency": "USD",
    "amount": "2.1862"
  },
  "day_profit_primary_display_currency": {
    "currency": "USD",
    "amount": "0.71497909537100944606510928410135170906899572324142"
  },
  "primary_display_currency_amount": {
    "currency": "USD",
    "amount": "33.41938674385577012455593960354579615351317609077582"
  },
  "total_primary_display_currency_profit": {
    "currency": "USD",
    "amount": 0.4197739212602701
  },
  "available_include_in_summary": true,
  "name": "New name exchange",
  "auto_balance_method": null,
  "auto_balance_error": null,
  "customer_id": null,
  "subaccount_name": null,
  "lock_reason": null,
  "btc_amount": "0.000576100372659584112793557824740668987777435277",
  "usd_amount": "33.41938674385577012455593960354579615351317609077582",
  "day_profit_btc": "0.000008477241194296886998580144867983802592279153250469",
  "day_profit_usd": "0.71497909537100944606510928410135170906899572324142",
  "day_profit_btc_percentage": "1.49",
  "day_profit_usd_percentage": "2.19",
  "btc_profit": "0.000032527150138595112793557824740668987777435277",
  "usd_profit": "0.41977392126027012455593960354579615351317609077582",
  "usd_profit_percentage": "1.27",
  "btc_profit_percentage": "5.98",
  "total_btc_profit": "3.2527150138595115e-05",
  "total_usd_profit": "0.41977392126027013",
  "pretty_display_type": "BybitSpot",
  "exchange_name": "Bybit Spot",
  "market_code": "bybit_spot",
  "api_keys_state": "ok"
}

400 Bad Request

{
  "error": "record_invalid",
  "error_description": "Invalid parameters",
  "error_attributes": {
    "api_key": [
      "This account is already connected!"
    ]
  }
}