Skip to main content
Rename a group dimension or change its key or description, and return it. Pass at least one of name, key or description. 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 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 used by another dimension of the company, archived ones included. Requires write permission on groups. Every write is recorded in the audit trail as the Qobra MCP agent.
Example arguments

Parameters

Body

string
required
Id from list_group_dimensions or create_group_dimension.
string
New display name.
string
New key, in the format and with the uniqueness of create_group_dimension’s key.
string
New note, replacing the current one. Pass an empty string to clear it.

Response

Body

object
The dimension as it now stands, the same shape list_group_dimensions returns.