Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Groups

Update a group

Updates the specified group. Only name and description can be updated. Any parameters not provided will be left unchanged.

put/groups/{group_id}

Path parameters

group_idstring required
Example:gr_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request body

namestring nullable

Human-readable name of the group.

descriptionstring nullable

Short description of the purpose or scope of the group.

Response

OK

idstring required

Unique identifier for the group. Prefixed with gr_.

namestring required

Human-readable name of the group.

descriptionstring nullable

Short description of the purpose or scope of the group.

status'pending' | 'ready' | 'archived' required
group_type'undefined' | 'single' | 'bundled' required
enrolment_type'manual' | 'automatic' required
employer_idstring required

Identifier for the employer that owns this group. Prefixed with er_.

objectstring

The object type

group_policy_idsstring[] required

Group policy unique identifiers associated with this group.

group_quote_intent_idsstring[] required

Group quote intent unique identifiers associated with this group.

group_policy_intent_idsstring[] required

Group policy intent unique identifiers associated with this group.

Example response

{
  "id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_policy_ids": [
    "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  ],
  "group_quote_intent_ids": [
    "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  ],
  "group_policy_intent_ids": [
    "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  ]
}