campaign-budgets:update
Change a campaign budget's caps, name or description. Omitted fields stay as they are and at least one must be given. A revoked budget cannot be updated. Raising a cap needs the extra credit headroom, as creating one does. Returns `budget`.
Reference for flywheel campaign-budgets:update.
Command Group
Approvals & Budgets Commands
Summary
Change a campaign budget's caps, name or description. Omitted fields stay as they are and at least one must be given. A revoked budget cannot be updated. Raising a cap needs the extra credit headroom, as creating one does. Returns budget.
Effect
DESTRUCTIVE: deletes, overwrites or revokes something
Usage
flywheel campaign-budgets:update <FLAGS>Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--root_node_id | string | UUID of a root node (no parents) from roots in graph:get. Tag commands refuse a non-root (400); budget commands use a descendant's root. | ||
--compute_budget_id | string | Campaign budget ID: compute_budget_id from campaign-budgets:create or a row of campaign-budgets:list. Not found, not a campaign budget or from another root: error. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--hard_cap_cents | integer | New cap for the whole budget, in cents; above 0. Raising it needs the extra credit headroom. Omitted: unchanged. | ||
--per_user_hard_cap_cents | integer | New per-participant cap, in cents; above 0 and at most the overall cap. Omitted: unchanged. | ||
--name | string | New label (surrounding whitespace dropped). Omitted: unchanged. | ||
--description | string | New note (surrounding whitespace dropped). Omitted: unchanged. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Bump hard cap.
flywheel campaign-budgets:update --root_node_id r --compute_budget_id b --hard_cap_cents 20000Output
Default format: json.
| Field | Type |
|---|---|
budget | object |
campaign-budgets:revoke
Mark a campaign budget revoked, so no new grant can be made from it. It does not stop spending already underway: participants' active grants and running leases continue until their own caps or credits run out; release leases with compute:release. Returns `budget`.
export:subgraph
Export nodes as one JSON document accepted by import:subgraph: version, exported_at, node_count and nodes (full records with content, summary, tags, artifacts and executions). Edges to nodes outside the export are dropped in both directions. --include_descendants adds visible descendants; exceeding --max_nodes fails with 422 export_node_limit_exceeded instead of a partial export.