name, key or description — a call with none of them
has nothing to update. Sending the values the dimension already has changes
nothing, so the same call can be sent twice.
A rename reaches every report that breaks down by the dimension, which reads
under its new name there once the background propagation has run. The
dimension’s groups are left as they are: rename one with
update_group.
The call is refused when the new key is already carried by another dimension of
the company.
Requires write permission on groups. Available only where the Qobra write tools
beta is enabled. Every write is recorded in the audit trail as the Qobra MCP
agent.
Example arguments
Parameters
Body
Body
string
required
Id of the dimension to update — the id list_group_dimensions returns, or
the one create_group_dimension just returned.
string
New display name for the grouping axis. Omit to leave the current name as
it is.
string
New stable key for the dimension — the identifier an integration matches
it on, distinct from the display name. Omit to leave the current key as it
is.
string
New free-text note about what the axis groups, replacing the current one
whole. Pass an empty string to clear it. Omit to leave the current
description as it is.
Response
Body
Body
object
The dimension as it now stands after the update — the same shape
list_group_dimensions returns.