Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountValueProtectionLimit Number Body If set, this value shields the total client value from going below the given limit by automatically triggering closing of positions should the limit be exceeded. A limit of zero means there is no limit.
    ClientKey ClientKey Query-String clientKey of the client that to switch.
    ForceOpenDefaultValue Boolean Body If True, the order(s) placed by default will be set to force open , therfore resulting positions will not automatically be netted with positions in the opposite direction
    NewPositionNettingMode ClientPositionNettingMode Body The position netting mode, client would like to switch to.
    NewPositionNettingProfile ClientPositionNettingProfile Body The position netting profile, client would like to switch to.
  • Response Parameters

    View Response Codes

    There are no response parameters

  • Request Example

    Request URL
    PATCH /port/v1/clients?ClientKey={ClientKey}
    Request Body
      "AccountValueProtectionLimit": 10,
      "ForceOpenDefaultValue": true,
      "NewPositionNettingMode": "Intraday",
      "NewPositionNettingProfile": "FifoEndOfDay"