Skip to main content

UpdateGroups

Shell for group operations on the update (UUID-based) flow.

Default: []

List of group UUIDs to delete.

Default: []

Example: "00633b08-165b-4dcb-bbae-0d3befa74c7e"

Unique identifier for the group.

When true, the group's direct member columns are excluded from wildcard queries unless include_hidden is set.

Policy for columns in this group's zone that are absent from an update.

UUID of the parent group within the same block model. Null means top-level.

Publisher-supplied free-form metadata for the group, as a JSON object. Keys must be 1-100 chars and cannot contain leading whitespace or dot, or the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single tags object serialised as UTF-8 JSON must be at most 10 KiB.

Human-readable label for the group, unique across the parent group, or across top-level groups if no parent. They must be 1-100 chars and cannot contain leading whitespace or dot, or the characters / \ : > < | ? " *. Must not contain the qualified title separator .

Default: []

UUID of the group to update.

Values that may be updated on an existing group via groups.update_metadata.

New hidden flag value.

New missing-column policy. Explicit null clears (inherits from parent); absent means leave unchanged.

New parent group UUID. Explicit null makes the group a root; absent means leave unchanged.

Publisher-supplied free-form metadata for the group, as a JSON object. Keys must be 1-100 chars and cannot contain leading whitespace or dot, or the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single tags object serialised as UTF-8 JSON must be at most 10 KiB.

New title for the group.

Was this page helpful?