UpdateAccountAlias
https://[domain]/ws/eca/update
-
Add or Update Account Alias for existing account
-
If you create an account alias, it will appear on account statements, portal, and TWS.
-
Who is this applicable for?
- All customer types.
Processing Time
-
Changes will be effective immediately. You will need to restart TWS OR Portal to view the new alias.
Request Parameters
XSD
<xsd:element name="UpdateAccountAlias">
<xsd:sequence>
<xsd:attribute name="reference_account_id" type="xsd:string" use="required">
<xsd:attribute name="accountAlias" type="xsd:string" maxOccurs="1" />
</xsd:sequence>
|
Name |
Type |
Description |
|---|---|---|
|
reference_account_id |
String |
IBKR account ID of the advisor/broker client account alias is requesting to be updated for. |
|
accountAlias |
String Max # of characters: 80
|
Account alias or Nickname
|
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<UpdateAccountAlias reference_account_id="U123456" accountAlias="Test Tester"/>
</AcctMgmtRequests>
|
Name |
Type |
Description |
|---|---|---|
|
Execution_Date |
YYYY/MM/DD HH:MM:SS |
Date/Time which the file was processed by IBKR. |
|
Process_File |
FirmName_YYYY-MM-DD_######.xml |
File name of the request file. |
|
Client |
FirmName |
Name of the Counterparty |
|
Client_Master_Acct |
String |
Master account number |
| UpdateAccountAlias | String | Status of the request |
| reference_account_id | String | IBKR account ID of the advisor/broker client account which the request is being submitted for |
| request_status |
PROCESSED ERROR PENDING |
Status of the request |
| message | String | Status of the request. |
| request_id | Non-negative integer | Unique ID which IBKR assigns to the request. The ID can be used to query status request at a later time using //getAmRequestStatus endpoint |
| message | String | Includes details on the status of the request IF status=”PENDING" or "PROCESSED " |
| Pending_Tasks | <Tasks> | Includes pending tasks associated with the info change request IF status=”PENDING" |
| Errors | String | Includes error message if status=”ERROR” |
Sample
<?xml version='1.0' encoding='UTF-8'?>
<Process>
<Execution ECA_XML_Schema_Version="15-Nov-2018">
<Execution_Date>2020/02/20 00:44:38</Execution_Date>
<Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
<Client>TesterFA</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<UpdateAccountAlias reference_account_id="U2088007" request_status="PROCESSED" message="Alias update processed" request_id="50813"/>
</Process>
<?xml version='1.0' encoding='UTF-8'?>
<Process>
<Execution ECA_XML_Schema_Version="15-Nov-2018">
<Execution_Date>2020/02/20 00:44:38</Execution_Date>
<Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
<Client>TesterFA</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<UpdateAccountAlias reference_account_id="U2088007" request_status="ERROR" request_id="50813">
<Error>Error Message Here</Error>
</UpdateAccountAlias>
</Process>
