update_pie
Modify an existing pie's settings, instrument allocations, or target weights. Update only the fields you provide; omitted fields remain unchanged. Requires the pie ID and name.
Instructions
Modify an existing pie's settings, instrument allocations, or target weights.
Only provided fields are updated - omitted fields remain unchanged.
Use fetch_a_pie first to see the current configuration before making changes.
The API requires providing a name even if you are not changing it.
Args:
pie_id: Numeric ID of the pie to modify (e.g., 6894572). Get this from fetch_pies.
name: Updated name for the pie. Required by the API even if unchanged.
instrument_shares: New ticker-to-weight mapping, must sum to 1.0.
Example: {'AAPL_US_EQ': 0.5, 'MSFT_US_EQ': 0.5}
dividend_cash_action: REINVEST or TO_ACCOUNT_CASH
end_date: Revised end date in ISO 8601 (e.g., '2029-12-31T23:59:59Z')
goal: Revised target value in account currency (e.g., 25000.0)
icon: Updated icon identifier
Returns:
PieDetails: The pie after applying your changesInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pie_id | Yes | ||
| name | No | ||
| instrument_shares | No | ||
| dividend_cash_action | No | ||
| end_date | No | ||
| goal | No | ||
| icon | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| settings | No | ||
| instruments | No |