Remove a dependent from a Dependents Management Intent

Removes a specific dependent from a Dependents Management Intent by their associated person ID. The operation returns the updated DMI state.

AuthorizationBearer

Authorization header using the Bearer scheme

dependents_management_intent_idstringRequiredformat: "dmi_.+"

associated_person_idstringRequiredformat: "ap_.+"

idstringformat: "dmi_.+"

Unique identifier for the dependents management intent. Prefixed with dmi_.

parent_intent_idstring

The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type.

parent_intent_typeenum

The type of parent intent.

Allowed values:

statusenum

Current status of the dependents management intent.

Allowed values:

dependentslist of objects

List of dependents being managed.

objectstring or null

Object type identifier.

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

1	{
2	"id": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"parent_intent_id": "string",
4	"parent_intent_type": "policy_amendment_intent",
5	"status": "action_required",
6	"dependents": [
7	{
8	"associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
9	"status": "pending_confirmation"
10	}
11	],
12	"object": "string"
13	}