Modifying a portfolio allocation

Prerequisites

✓ Have a portfolio allocation

Details

Before you can modify portfolio allocations, you must have created at least one portfolio allocation. See the Creating portfolio allocations step of this tutorial for details.

The Investment API provides flexibility in customising initial portfolio allocations.

→ Changing a portfolio allocation

With the following API call, you can add, replace, or remove individual instruments, adjust respective target weights or modify the naming of the allocation. This allows you and your users to react to changing market conditions, investor preferences, and new information at any time:

PUT /portfolios/allocations/{allocation_id}

Example request

{
    "name": "Allocation 1",
    "allocation": [
        {
            "instrument_id": "IE00BOM62Q58",
            "instrument_id_type": "ISIN",
            "weight": "0.5"
        },
        {
            "instrument_id": "US0378331005",
            "instrument_id_type": "ISIN",
            "weight": "0.3"
        },
        {
            "instrument_id": "6d7d7d64-e174-4b6b-84e0-306¢96382166",
            "instrument_id_type": "UPVEST",
            "weight": "0.2"
        }
    ]
}

INFO

Please note that the allocation array included in this request must always contain the complete new allocation and thus fully represent the new target state (i.e. no delta updates).

The example call results in the following changes to the portfolio allocation:

The weight of the first instrument is reduced from 0.7 to 0.5
A third instrument is added to the allocation using an Upvest UUID as instrument identifier (i.e. for a cryptocurrency).

Once a portfolio allocation is successfully updated, you will receive a webhook notifying you about the change.

WARNING

Webhooks notify you of events in business processes, not the success or failure of the initialisation of those processes.

Please be sure to check the HTTP status of the response to your requests and handle failure cases appropriately.

INFO

Note that by changing an allocation that is already used in one or more portfolio configurations, you automatically change the defined target allocation of the investment in the respective accounts. If you want the change to take effect immediately, you can trigger a rebalancing of the accounts to the new target allocation as described in the guide 'Triggering a rebalancing'.

✔ Portfolio allocation management

Congratulations, you now know how to manage portfolio allocations.