Update report group

Full update of a report group and its subgroups. Subgroups are matched by id: keep each existing subgroup's id, and any subgroup omitted from the list is deleted (a subgroup with reports cannot be removed this way; delete it via /api/reporting/metrics/groups/{id} instead). At least one subgroup must be active. First retrieve the current group from /api/reporting/metrics/groups/{id}, apply your changes, then send back the full object.

Required permission: Metrics Settings

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the report group.

Body Params

The report group details

string | null
required

The name of the report group (max 100 characters).

int32

The unique id of the report group. Providing an existing group's id updates that group instead of creating a new one. When updating a group, keep each existing subgroup's id; subgroups without an id are created.

string | null

The abbreviation shown for the group where space is limited (max 5 characters, stored uppercase). Required on top-level groups; not used on subgroups.

string | null

The display color of the group (hex code). Required on top-level groups; not used on subgroups.

boolean

Whether the group is active.

subgroups
array of objects | null

The group's subgroups, including inactive ones. Subgroups carry a name and active flag only; at least one active subgroup is required.

subgroups
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json