Update budget

Update an existing budget. Only the fields included in the request body are modified; omitted fields remain unchanged.

Common updates include adjusting the target amount, modifying scopes, updating subscriber lists, or changing threshold percentages.

A hierarchical budget's allocations must cover exactly the values of the scope they split, after the update as well as before it. To add or remove a value, send scopes in the same request as hierarchicalAmount, or, for a variable budget, as periods covering every current and future period. An update that leaves them mismatched fails with 400 and changes nothing.

Threshold cadence must fit the resulting budget period: MONTH permits DAILY_SPEND and MONTHLY_SPEND; QUARTER also permits QUARTERLY_SPEND; YEAR also permits YEARLY_SPEND. Forecasted spend is allowed only for the threshold matching the full budget period; shorter daily/checkpoint thresholds use actual spend. These rules also apply to sub-budget alerts. percent is a numeric percentage, not a monetary amount. Supplied linkedReports replaces the full list; [] clears links and omission retains them. Internal links use a reportID; external links use a name and URL.

limitVersions selects LATEST or HIGHLIGHTED budget amounts. Actual daily/checkpoint spend is compared with a percentage of the whole budget-period amount. Numeric percent is not restricted to the UI editor's 1–100 range. Incompatible cadence/forecast rules return 400 without changing the budget.

The built-in Budget Report is separate from these added links and cannot be removed through linkedReports.

Path Params
string
required
length ≥ 1

Unique budget ID

Body Params
number | null

Dollar value of the budget

hierarchicalAmount
object
boolean

Whether the budget uses variable amounts by period. When true, a top-level numeric amount is rejected; this does not mean a fixed recurring amount.

string
length ≥ 1

Budget measure

string
length ≥ 1

Budget name

period
object

Budget period. Omit on PATCH to retain the saved period; creation defaults to a calendar month.

periods
array of objects

Period versions

periods
scopes
array of objects
length ≥ 1
scopes
slackChannelIDs
array of strings

Slack channel IDs to receive budget notifications

slackChannelIDs
subscribers
object
thresholds
array of objects
thresholds
webhookIDs
array of uuids, unique
length ≤ 10

Webhook IDs to receive budget notifications

webhookIDs
linkedReports
array

Complete replacement list of linked reports. Omit to retain links; send [] to clear them. Internal links use reportID; external links use a nonempty name without HTML and an http(s) URL or a relative path starting with a single slash.

linkedReports
Responses

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