update_budget
Destructive
Modify an existing budget with partial updates. Adjust amount, currency, type, time interval, alerts, and more after user confirmation.
Instructions
Use this when the user wants to modify an existing budget. Supports partial updates. Ask the user to confirm the changes before executing. Do NOT use this for viewing budgets (use list_budgets) or creating new budgets (use create_budget).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Budget name. Must be non-empty if provided. | |
| amount | No | Budget period amount. | |
| currency | No | Currency code. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP. | |
| type | No | Budget type. Accepted values: fixed, recurring. | |
| timeInterval | No | Recurring budget interval. Accepted values: day, week, month, quarter, year. | |
| startPeriod | No | Budget start date as a UNIX timestamp in milliseconds. | |
| endPeriod | No | Fixed budget end date as a UNIX timestamp in milliseconds. Must not be set for recurring budgets. | |
| description | No | Budget description. | |
| usePrevSpend | No | Use the last period's spend as the target amount for recurring budgets. Defaults to false. | |
| growthPerPeriod | No | Periodical growth percentage in recurring budgets. Must be >= 0. Defaults to 0. | |
| metric | No | Budget metric. Accepted values: cost, amortized_cost. Defaults to cost. | |
| public | No | Public sharing access level. Accepted values: owner, editor, viewer. | |
| scopes | No | Filters that define the scope of the budget. Cannot be combined with scope. | |
| scope | No | List of allocations that define the budget scope (deprecated). Cannot be combined with scopes. | |
| collaborators | No | List of permitted users to view/edit the budget. If provided, must include at least one collaborator with role 'owner'. | |
| alerts | No | List of up to three alert thresholds defined as a percentage of the amount. | |
| recipients | No | List of email addresses to notify when reaching an alert threshold. | |
| recipientsSlackChannels | No | List of Slack channels to notify when reaching an alert threshold. | |
| seasonalAmounts | No | List of seasonal amounts for recurring budgets with different amounts per period. | |
| id | Yes | The ID of the budget to update (required). |