Add an employee to a group

Adds an existing employee to a group. The employee must belong to the same employer as the group. If there is a group_policy associated with the group, a corresponding enrolment_intent will be created for the employee.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path Parameters

group_idstringRequiredformat: "gr_.+"

Request

This endpoint expects an object.

employee_idstringRequiredformat: "ee_.+"

Employee Id

policy_configurationobject or nullOptional

Policy configuration for the employee in this group. Leave null to use group defaults.

Response

idstringformat: "ee_.+"

Unique identifier for the employee.

policieslist of objects

List of policies associated with the employee in this group.

enrolmentslist of objects

List of enrolments associated with the employee in this group.

desired_policy_start_datestring or nullformat: "date"

1	import requests
2
3	url = "https://test.api.kota.io/groups/gr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employees"
4
5	payload = { "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"policies": [
4	{
5	"id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
6	}
7	],
8	"enrolments": [
9	{
10	"id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a"
11	}
12	],
13	"desired_policy_start_date": "2024-12-01"
14	}

Authentication

Path Parameters

Headers

Request

Response

Errors