create_group - Qobra public API documentation

Create a group, one value of an existing dimension (‘EMEA’ under ‘Region’), and return it. The dimension has to exist first; create it with create_group_dimension. The group is created empty unless attributions fills it, and the memberships this creates are reported in attribution_changes; update_group sets the membership later. The new value is added to the dimension’s picklist in every reporting table. The call is refused for an archived dimension, a key the dimension already uses, an archived or unknown user among the attributions, or one user over overlapping months. Every write is recorded in the audit trail as the Qobra MCP agent.

Parameters

Body

string

required

Id from list_group_dimensions or create_group_dimension, of an active dimension. Never a name.

string

required

Display name, one value of the dimension (‘France’).

string

required

Stable key, unique within the dimension (archived groups included): lowercase letters, digits and _ only, stored as sent (‘emea_north’).

object[]

Who is in the group from creation: every user, each with the months they belong for. Omit for an empty group.

Show object properties

string

required

Id or exact email of the user.

string

required

YYYY-MM; the first month this membership covers.

string

YYYY-MM; the last month it covers, included. Omit it for a membership that stays open with no end.

Response

Body

object

The group as it now exists — the same row list_groups returns, so the id can be reused straight away.

Show object properties

string

Deep link to open this group in the Qobra web app.

string

Stable key; integrations match the group on it.

object

The dimension (kind of grouping) of the group.

Show object properties

string

boolean

integer

Users in the group today; past and future memberships are not counted.

object[]

Show object properties

string

“created” for a membership this call added; “moved” for one that already existed and had its dates changed, the row showing the new ones; “removed” for one the declared set no longer holds. Only what actually changed is named — a membership already matching what was declared is absent from the list, which is how a re-sent set reads as the no-op it was.

object

The membership as it now stands; for a removed row, its last state before removal.

Show object properties

object

Show object properties

string

YYYY-MM; the month the user joined the group.

string

YYYY-MM; null while the membership is still ongoing.

​Parameters

​Response

Parameters

Response