Update Alias Account For Current User

Overview

This endpoint enables users to add or update an alias for a trading account.

An alias serves as a nickname or custom label for the account, providing an alternative name for easier identification and navigation.

For instance, if a client shares an account with their spouse, they can add an alias like "Family Account" to refer to it instead of using the account number.

Update Alias Account For Current User

PUT baseURL/v{version}/accounts/{accountId}/alias/{alias}

Path Parameters

NameTypeDescription

apiVersion*

The version of API. By default, set it to 1.0.

accountId*

integer

The internal ID of the trading account to which the alias will be assigned.

alias*

String

The custom name (alias) that the user wants to assign to the trading account.\

Headers

NameTypeDescription

Authorization*

String

This is the authorization token from the token request. The value of this header must have the following format: Bearer BQ898r9fefi (Bearer + 1 space + the token).

Last updated