Update Account
update_accountUpdate an existing account's name, currency, platform, comment, or balance. Provide only the fields you want to change; missing fields are retained from current state.
Instructions
Update settings or details of an existing account.
Ghostfolio's update endpoint replaces the whole account record, so
name, currency and platform_id are required on every request even
when they are not changing. Any left unset here are backfilled from the
account's current state with a GET before the PUT, so you only need to
pass the fields you actually want to change.
Setting balance here applies it as today's entry in the account's
balance history (the same series get_account_balances returns and
get_portfolio_holdings derives its cash figure from) - it is not a
separate stale field. Use create_account_balance to set the balance
for a specific past date instead of today.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Optional new name of the account | |
| balance | No | Optional new balance for the account | |
| comment | No | Optional new comment or note for the account | |
| currency | No | Optional new currency code for the account (e.g., 'USD', 'EUR') | |
| account_id | Yes | Account ID to update | |
| platform_id | No | Optional new platform ID for the account |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||