GuidesAPI Reference
Log In
API Reference

/participants/{participant_id}/portfolio/

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates a participant's target portfolio allocations.

Expects:

- investments: list of investment ids

- weights: list of target percent weights (aligned by index with investments)

0% allocations

Setting an investment target allocation to 0% does not remove it from the portfolio. If auto_rebalance is disabled,no trades will occur until a manual rebalance is triggered.

The exception is an investment outside the participant's investment options (for example, a fund removed from the plan's lineup or a closed fund they still hold). Setting one of these to 0% removes it from the portfolio, the same as omitting it.

Removing an investment

Any allocation you specify in a POST request replaces any prior allocation.Thus, to remove an investment from the portfolio, simply post an allocation without that investment.Once an investment is removed from the portfolio, the system will sell all shares of that investmentregardless of whether auto_rebalance is enabled. Removed investments enter PENDING_SALE until liquidation is complete.

Path Params
string
required
Query Params
integer

A page number within the paginated result set.

integer

Number of results to return per page.

Body Params
investments
array of strings or null
required

List of investment IDs

investments*
weights
array of strings
required

List of investment weights. The order of weights must parallel the order of investments.

weights*
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

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