Add Account To User By Username

Overview

This API endpoint enables you to bind a new or an existing trading account to an existing user.

Add Account To User By Username

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

Path Parameters

NameTypeDescription

apiVersion*

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

accountId*

integer

This is the internal identifier of the trading account which is to be bound to an existing user.

username*

String

This field represents the username of the user to whom an existing trading account should be bound.\

Query Parameters

NameTypeDescription

accessType*

String

This is the access level the user should have to this trading account. Available values: Full, ReadOnly, ClosePositionsOnly, Owner.

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).

{
  "UserModel": {
    "UserId": 0,
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Login": "string",
    "Email": "string",
    "Role": 0,
    "AddedDate": "2023-07-28T14:00:07.136Z",
    "Salutation": "NoSalutation",
    "Suffix": "NoSuffix"
  },
  "AccountAccessType": "Full"
}

Last updated