update_dashboard_version
Name a snapshot or clear its name, which also exempts it from the autosave prune. Parameters, limits, errors and scope rules.
Sets or clears the label of one prior snapshot, for example Before redesign or
Q2 final. This only edits metadata: it does not change the dashboard body and
does not restore anything.
Naming a version does one thing beyond labelling it: it exempts the version from the automatic 20-snapshot prune, and it is the only way to keep a snapshot indefinitely.
Behaviour hints for clients: not read-only, idempotent, not open-world.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
slug | string | yes | Canonical slug of the dashboard the version belongs to. |
version_id | string | yes | A UUID belonging to this dashboard, from list_dashboard_versions. |
label | string | yes | The new label, maximum 80 characters. Pass an empty string to clear the name. |
workspace | string | no | Workspace slug. |
label is required, because clearing is expressed as an empty string rather
than as omission. Omitting it is an argument error, not a no-op.
Returns
One line. Naming:
Labeled version 2c91... of revenue-overview as "Before redesign".Clearing:
Cleared the label on version 2c91... of revenue-overview.Errors
The same set as
restore_dashboard_version,
plus:
| Condition | Text |
|---|---|
| Wrong type | label must be a string or null |
| Too long | label must be 80 characters or fewer |
| The write failed | set version label failed: <err> |
Naming a version past the cap of 30 named versions is refused, carrying the
named version limit reached text. Clearing the name of another version frees a
slot.
Scope
Workspace-capable. Any member may name a snapshot of a workspace dashboard.
Check it worked
Run list_dashboard_versions and
confirm the entry now shows the quoted label. To confirm the prune exemption
took, name a version older than your 20 most recent and check it survives the
next few republishes.