Delete an associated person | Kota Embed Documentation

Permanently deletes an associated person. It cannot be undone.

AuthorizationBearer

Authorization header using the Bearer scheme

employee_idstringRequiredformat: "ee_.+"

associated_person_idstringRequiredformat: "ap_.+"

idstringformat: "ap_.+"

Unique identifier for the associated person

employee_idstringformat: "ee_.+"

Unique identifier for the employee this person is associated with

first_namestring

First name of the associated person

last_namestring

Last name of the associated person

date_of_birthdate

Date of birth of the associated person

sex_at_birthenum

The sex assigned to the associated person at birth

Allowed values:

relationship_typeenum

The relationship type between the employee and the associated person

Allowed values:

emailstring or null

Email address of the associated person

phone_numberstring or null

Phone number in E.164 international format (e.g. +447700900999)

objectstring or null

The object type

1	import requests
2
3	url = "https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/associated_persons/ap_3b1333d87d9d4fd6ad83ba7f6b0e951a"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.delete(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4	"first_name": "string",
5	"last_name": "string",
6	"date_of_birth": "2024-12-01",
7	"sex_at_birth": "male",
8	"relationship_type": "spouse",
9	"email": "string",
10	"phone_number": "string",
11	"object": "string"
12	}