Portfolios

Update Portfolio

Updates a Portfolio by portfolioID.

patch/managed/portfolios/{portfolioID}

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/managed/portfolios/{portfolioID}
Auth
HTTP bearer

Path parameters

portfolioIDstring required

A unique identifier associated with a specific Portfolio.

Request body

namestring

A name given to the Portfolio by the RIA.

clientPortfolioIDstring

A user defined identifier attached to the portfolio.

descriptionstring

A short description for the portfolio.

Example request

{
  "name": "Recession Proof",
  "clientPortfolioID": "AAABBB-1222-3344.123456789",
  "description": "A portifolio description.",
  "holdings": [
    {
      "type": "FUND",
      "id": "fund_123e4567-e89b-12d3-a456-000000000011",
      "target": 0.95
    }
  ],
  "triggers": {
    "type": "TOTAL_DRIFT",
    "maxAllowed": 0.05,
    "lowerBound": 0.01,
    "upperBound": 0.02
  }
}

Response

Updating a Portfolio by portfolioID was Successful.

idstring

The unique identifier associated with a portfolio.

namestring

A name given to the Portfolio by the RIA.

clientPortfolioIDstring

A user defined identifier attached to the portfolio.

descriptionstring

A short description for the Portfolio.

userIDstring

sensitive The unique identifier of the registered investment advisors account.

isFundTargetsChangedboolean

fundsTargetsChangedboolean

Example response

{
  "id": "portfolio_123e4567-e89b-12d3-a456-00000000000b",
  "name": "Recession Proof",
  "clientPortfolioID": "AAABBB-1222-3344.123456789",
  "description": "A portifolio description",
  "holdings": [
    {
      "id": "fund_123e4567-e89b-12d3-a456-000000000011",
      "name": "TECH",
      "type": "FUND",
      "clientFundID": "AAABBB-1222-3344.123456789",
      "description": "Top 10 US Tech",
      "target": 0.95,
      "holdings": [
        {
          "instrumentID": "123e4567-e89b-12d3-a456-000000000003",
          "target": 0.5
        }
      ],
      "triggers": [
        {
          "type": "TOTAL_DRIFT",
          "maxAllowed": 0.05,
          "lowerBound": 0.01,
          "upperBound": 0.02
        }
      ]
    }
  ],
  "userID": "123e4567-e89b-12d3-a456-000000000167",
  "triggers": [
    {
      "type": "TOTAL_DRIFT",
      "maxAllowed": 0.05,
      "lowerBound": 0.01,
      "upperBound": 0.02
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.