Create report group

post

https://{tenant}.onechurchsoftware.com/api/reporting/metrics/groups

Create a top-level report group with its subgroups. Reports are submitted to a group's subgroups, and at least one active subgroup is required.

Required permission: Metrics Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The report group details

name

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.

abbreviation

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.

color

string | null

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

active

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.

200OK