Update an employer | Kota Embed Documentation

Updates the specified employer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the legal_address parameter only the legal_address value will be changed.

Note that the legal_address and contact fields are treated as single objects that are updated entirely. If you provide either of these fields, the entire object will be replaced with the new data, not just the individual sub-fields you include in the request.For instance, if you provide a partial legal_address object, it will overwrite the entire existing legal_address, potentially removing any sub-fields you didn’t include in the request.

This request accepts mostly the same arguments as the employer creation call.

Updates the specified `employer` by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the `legal_address` parameter only the `legal_address` value will be changed. Note that the `legal_address` and `contact` fields are treated as single objects that are updated entirely. If you provide either of these fields, the entire object will be replaced with the new data, not just the individual sub-fields you include in the request.For instance, if you provide a partial `legal_address` object, it will overwrite the entire existing `legal_address`, potentially removing any sub-fields you didn't include in the request. This request accepts mostly the same arguments as the `employer` creation call.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

employer_idstringRequiredformat: "er_.+"

Request

This endpoint expects an object.

legal_namestring or nullOptional

registration_numberstring or nullOptional

legal_addressobject or nullOptional

Treated as a single object that is updated entirely, null sub-fields (e.g. Line 3) will delete the existing values

contactobject or nullOptional

earliest_benefits_start_datedate or nullOptional

Constraints:

Can only be set or updated if no group policy or group quote exists.
Must be a valid date.

The earliest date this employer is permitted to set up any benefits scheme. If this date is in the future, benefit setup will be blocked until then. Used to delay scheme setup access (e.g., for onboarding alignment). **Constraints:** - Can only be set or updated if no group policy or group quote exists. - Must be a valid date.

metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. Treated as a single object that is updated entirely.

Response

idstringformat: "er_.+"

legal_namestring

legal_addressobject

contactobject

platform_idstring or nullformat: "pt_.+"

statusenum or null

Allowed values:

registration_numberstring or null

offboard_ondatetime or null

earliest_benefits_start_datedate or null

metadatamap from strings to strings or null

objectstring or null

The object type

Errors

This request accepts mostly the same arguments as the employer creation call.

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

1	{
2	"id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"legal_name": "Acme Corporation Ltd",
4	"legal_address": {
5	"line1": "string",
6	"city": "string",
7	"postal_code": "string",
8	"country_code": "af",
9	"line2": "string",
10	"line3": "string",
11	"state": "string"
12	},
13	"contact": {
14	"name": "string",
15	"email": "string"
16	},
17	"platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
18	"status": "pending",
19	"registration_number": "12345678",
20	"offboard_on": "2024-12-01T00:00:00Z",
21	"earliest_benefits_start_date": "2024-12-01",
22	"metadata": {},
23	"object": "string"
24	}