API ReferenceTradingTrading Fa Allocation Management

Modify Allocation Group

View as MarkdownOpen in Claude
Modify an existing allocation group.

Authentication

AuthorizationBearer
SSO bearer token.

Request

This endpoint expects an object.
namestringRequired

Name used to refer to your allocation group. If prev_name is specified, this will become the new name of the group.

accountslist of objectsRequired

An array of accounts that should be held in the allocation group and, if using a User-specified allocaiton method, the value correlated to the allocation.

default_methodenumRequiredDefaults to N
Interactive Brokers supports two forms of allocation methods. Allocation methods that have calculations completed by Interactive Brokers, and a set of allocation methods calculated by the user and then specified. IB-computed allocation methods: * `A` - Available Equity * `E` - Equal * `N` - Net Liquidation Value User-specified allocation methods: * `C` - Cash Quantity * `P` - Percentage * `R` - Ratios * `S` - Shares
prev_namestringOptional
Can be used to rename a group. Using this field will recognize the previous name, while the "name" filed will mark the updated name.

Response

Returns a confirmation that the modification was successful.
successbooleanOptional

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error