Archive grouping set

Archives the grouping set (logical delete). The record is marked archived and is omitted from GET /groupingsets collection results, but can still be retrieved with GET /groupingsets/{groupingSetId}.

You cannot archive the grouping set that is currently the default (isDefault is true) until another grouping set is made default; otherwise the service returns 400 Bad Request.

When a grouping set is archived, default grouping behavior may be adjusted automatically according to platform rules (for example to retain a tenant default using the platform-seeded grouping set).

The caller must be authorized to manage grouping sets; otherwise the service returns 403 Forbidden.

Path Params
int64
required
≥ 1

ID of the grouping set.

Responses
204

Success. Grouping set archived.

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json