Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Dependents

Update dependent information

dependents.update(strdependent_id, DependentUpdateParams**kwargs) -> Dependent
put/v1/dependents/{dependent_id}

Updates an existing dependent's mutable information. Allows modification of relationship type and active status. Name, DOB, and sex cannot be modified after creation.

ParametersExpand Collapse
dependent_id: str
active: Optional[bool]

Whether the dependent is active

gender: Optional[str]

Gender identity

relationship: Optional[Relationship]
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"
ReturnsExpand Collapse
class Dependent: …

Serializer for Dependent entity in public API responses.

Dependents are family members (spouse, children) who may be eligible for benefit coverage through an employee.

id: str

Unique dependent identifier with 'dpnd_' prefix

active: bool

Whether the dependent is currently active

created_at: datetime

Timestamp when the dependent was created

formatdate-time
date_of_birth: date

Dependent's date of birth (YYYY-MM-DD)

formatdate
first_name: str

Dependent's legal first name

last_name: str

Dependent's legal last name

member_id: str

ID of the primary member/employee (mbr_*)

relationship: Relationship
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"
sex: Sex
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
Accepts one of the following:
"Male"
"Female"
"Other"
"Unknown"
updated_at: datetime

Timestamp when the dependent was last updated

formatdate-time
gender: Optional[str]

Gender identity, if provided

ssn_last_four: Optional[str]

Last 4 digits of SSN (masked)

suffix: Optional[str]

Name suffix (e.g., Jr., Sr., III)

Update dependent information
from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
dependent = client.dependents.update(
    dependent_id="dpnd_abc123def456",
)
print(dependent.id)
{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "date_of_birth": "2019-12-27",
  "first_name": "first_name",
  "last_name": "last_name",
  "member_id": "member_id",
  "relationship": "Spouse",
  "sex": "Male",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "gender": "gender",
  "ssn_last_four": "ssn_last_four",
  "suffix": "suffix"
}
Returns Examples
{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "date_of_birth": "2019-12-27",
  "first_name": "first_name",
  "last_name": "last_name",
  "member_id": "member_id",
  "relationship": "Spouse",
  "sex": "Male",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "gender": "gender",
  "ssn_last_four": "ssn_last_four",
  "suffix": "suffix"
}