Update fixed income portfolio

Update a fixed income portfolio.

Required scopeRequired feature flag
portfolio:writeFIXED_INCOME_ANALYZER
Path Params
string
required

ID of the portfolio to update

Query Params
boolean

Is this a saved portfolio (defaults to false)

Body Params
string
number

The amount of money this portfolio is worth defined as {"amount": 500000.50, "currency": "CAD" }

string
Defaults to CAD
number
boolean
Defaults to false
uuid

this points to the other portfolio (UUID) this was generated from

boolean
Defaults to true

Is this only visible to the owner?

string
enum
Defaults to client
  • client: Portfolio created by an advisor that can be used to present to a client
  • model: Portfolio that is created by either an advisor or by Picton Mahoney that can be used to compare to a client portfolio
  • PMAM_model: Picton Mahoney model that is essentially a Picton Mahoney product.Can not be changed by advisors.
  • benchmark: Portfolio that is generated by the system such as a composite index(Example: S & P 500)
  • customized_benchmark: ???
  • individual_investment: A single stock market symbol(Examples from the USA: GOOG, TSLA, F, GOLD)
Allowed:
string
enum
Defaults to broad_reference

The portfolio type, currently either Broad Reference or Startegic Benchmark

Allowed:
sleeves
array of objects

Associated Allocations for this Portfolio

sleeves
string
enum

Specifies if this is a us equity or canadian equity. Only for Equity analyzer

Allowed:
string
Defaults to null

this is the advisor that requests the wholesaler to create a portfolio

string
Defaults to null

this is the dealership to which the advisor belongs

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json