Update a group | Kota Developer Products Documentation

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

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

group_idstringRequiredformat: "gr_.+"

Request

This endpoint expects an object.

namestring or nullOptional

Human-readable name of the group.

descriptionstring or nullOptional

Short description of the purpose or scope of the group.

Response

idstringformat: "gr_.+"

Unique identifier for the group. Prefixed with gr_.

namestring

Human-readable name of the group.

statusenum

Current lifecycle state of the group, indicating its current progress. Possible values are:

pending: Group is being configured, may require a quote_intent or a setup_intent to be ready.
ready: Setup is complete, regardless of policy start dates employees could start enrolling into policies.
archived: Archived as the group is no longer active or in use for any reason. Employees can no longer be added to the group.

Current lifecycle state of the `group`, indicating its current progress. Possible values are: - `pending`: Group is being configured, may require a `quote_intent` or a `setup_intent` to be ready. - `ready`: Setup is complete, regardless of policy start dates employees could start enrolling into policies. - `archived`: Archived as the group is no longer active or in use for any reason. Employees can no longer be added to the group.

Allowed values:

group_typeenum

Indicates how policies are organized for this group.

single: exactly one policy is associated to the group.
bundled: multiple policies are bundled under the group.
undefined: type not yet determined or not applicable.

Indicates how policies are organized for this group. - `single`: exactly one policy is associated to the group. - `bundled`: multiple policies are bundled under the group. - `undefined`: type not yet determined or not applicable.

Allowed values:

employer_idstringformat: "er_.+"

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

group_policy_idslist of strings

Group policy unique identifiers associated with this group.

group_quote_intent_idslist of strings

Group quote intent unique identifiers associated with this group.

group_setup_intent_idslist of strings

Group setup intent unique identifiers associated with this group.

descriptionstring or null

Short description of the purpose or scope of the group.

objectstring or nullRead-only

The object type

1	curl -X PUT https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"name": "string",
4	"status": "pending",
5	"group_type": "undefined",
6	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7	"group_policy_ids": [
8	"gp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
9	],
10	"group_quote_intent_ids": [
11	"gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a"
12	],
13	"group_setup_intent_ids": [
14	"gsi_3b1333d87d9d4fd6ad83ba7f6b0e951a"
15	],
16	"description": null,
17	"object": "string"
18	}

Authentication

Path parameters

Request

Response

Errors