Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Members
Qualifying Life Events

Record qualifying life event

members.qualifying_life_events.record(strmember_id, QualifyingLifeEventRecordParams**kwargs) -> QualifyingLifeEvent
post/v1/members/{member_id}/qualifying-life-events

Records a qualifying life event occurrence for a member. Opens a special enrollment period allowing benefit changes outside open enrollment. Employees typically have 30-60 days from the event date to complete enrollment changes.

ParametersExpand Collapse
member_id: str
event_date: Union[null, null]

Date when the event occurred

formatdate
event_type: EventType
  • Marriage - Marriage
  • Birth - Birth
  • Adoption - Adoption
  • Divorce - Divorce
  • Death - Death
  • Job Loss - Job Loss
  • Reduction In Hours - Reduction In Hours
  • Employer Bankruptcy - Employer Bankruptcy
  • Medicare Entitlement - Medicare Entitlement
  • Termination - Termination
  • Other - Other
Accepts one of the following:
"Marriage"
"Birth"
"Adoption"
"Divorce"
"Death"
"Job Loss"
"Reduction In Hours"
"Employer Bankruptcy"
"Medicare Entitlement"
"Termination"
"Other"
notes: Optional[str]

Optional notes about the event

maxLength1000
ReturnsExpand Collapse
class QualifyingLifeEvent: …

Serializer for Qualifying Life Event entity in public API responses.

QLEs are significant life changes (marriage, birth, adoption, loss of coverage) that allow employees to modify benefit elections outside of open enrollment.

id: str

Unique QLE identifier with 'qle_' prefix

created_at: datetime

Timestamp when the QLE was created

formatdate-time
employee_id: str

ID of the employee (empl_*)

enrollment_window_end: date

End of the special enrollment period (typically 30-60 days from event)

formatdate
enrollment_window_start: date

Start of the special enrollment period

formatdate
event_date: date

Date when the qualifying life event occurred

formatdate
event_type: str

Type of qualifying life event (e.g., 'marriage', 'birth', 'adoption', 'loss_of_coverage', 'divorce')

member_id: str

ID of the member experiencing the life event (mbr_*)

status: QualifyingLifeEventStatus
  • pending - Pending
  • approved - Approved
  • denied - Denied
Accepts one of the following:
"pending"
"approved"
"denied"
updated_at: datetime

Timestamp when the QLE was last updated

formatdate-time
notes: Optional[str]

Additional notes or comments about the QLE

reviewed_at: Optional[datetime]

Timestamp when the QLE was reviewed, if reviewed

formatdate-time
reviewed_by: Optional[str]

ID of the user who reviewed the QLE, if reviewed

Record qualifying life event
from datetime import date
from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
qualifying_life_event = client.members.qualifying_life_events.record(
    member_id="mbr_abc123def456",
    event_date=date.fromisoformat("2019-12-27"),
    event_type="Marriage",
)
print(qualifying_life_event.id)
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "enrollment_window_end": "2019-12-27",
  "enrollment_window_start": "2019-12-27",
  "event_date": "2019-12-27",
  "event_type": "event_type",
  "member_id": "member_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "notes": "notes",
  "reviewed_at": "2019-12-27T18:11:19.117Z",
  "reviewed_by": "reviewed_by"
}
Returns Examples
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "enrollment_window_end": "2019-12-27",
  "enrollment_window_start": "2019-12-27",
  "event_date": "2019-12-27",
  "event_type": "event_type",
  "member_id": "member_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "notes": "notes",
  "reviewed_at": "2019-12-27T18:11:19.117Z",
  "reviewed_by": "reviewed_by"
}