Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    DisplayName String Body The Display name for investment
    FundingAccountKey AccountKey Body The account from where to withdraw any additional funding amount.
    InvestmentId String Route Id of the investment to update
    InvestmentShieldAmount Decimal Body Investment shield amount (drawdown protection level).
    IsActive Bool Body Set the investment active or inactive.
    IsAutoFundsTransfer Bool Body Auto Funds transfer value in case of investment stop
    PendingFunding Decimal Body Any pending funding amount.
    PositionsCloseOnDeactivation Bool Body Option to close or keep positions on deactivation (not available to all)
  • Response Parameters

    View Response Codes

    There are no response parameters

  • Request Example

    Request URL
    PATCH at/v3/investments/1505
    Request Body
    {
      "DisplayName": "Investment Account",
      "FundingAccountKey": "nUAg42i1-LI7kgWmWfSoaw==",
      "InvestmentShieldAmount": 80000.0,
      "IsActive": true,
      "PendingFunding": 0.0,
      "PositionsCloseOnDeactivation": true
    }