Skip to main content
POST
Add assignment preference

Authorizations

APIKey
string
header
required

General API key with at least read-only access

Authent
string
header
required

Authentication string

Query Parameters

contractType
string
required

Type of contract for the assignment program preference. Options can be found in the 'accounts' structure in the Get Wallets /accounts response

contract
string

A specific contract for this assignment program preference. Required for "flex" contracts if base/quote currencies are not included.

maxSize
number

The maximum size for an assignment

maxPosition
number

The maximum position

acceptLong
boolean
required

Accept to take long positions

acceptShort
boolean
required

Accept to take short positions

timeFrame
enum<string>
required

When is the program preference valid

Available options:
WEEKDAYS,
WEEKEND,
ALL
enabled
boolean
required

enabled assignment

baseCurrency
string

If creating a currency pair level assignment participant, this specifies the base currency.
Must be specified alongside the quote currency.

quoteCurrency
string

If creating a currency pair level assignment participant, this specifies the quote currency.
Must be specified alongside the base currency.

cashAccountOpenPositionMaxNotional
number

Specify max open position notional for wallet type

Response

200 - application/json
id
number
required
participant
object
required
Example:
result
enum<string>
required
Available options:
success
Example:

"success"

serverTime
string<date-time>
required

Server time in Coordinated Universal Time (UTC)

Example:

"2020-08-27T17:03:33.196Z"