Sign in
Eligibility

eligibility

Partially updates an eligibility.<p>Scopes: import_plan</p>

patch/v{version}/eligibilities/{id}

Path parameters

idstring required
versionstring required

Request body

namestring

The eligibility name.

policy_numberstring

The Policy Number of the eligibility.

subgroup_numberstring

The subgroupnumber of the eligibility.

scheduled_hoursstring

The scheduledhours of the eligibility.

waiting_period_amountinteger

The waiting period amount of the eligibility.

waiting_period_type'Days' | 'Months' | ''

The waiting period type of the eligibility.

entry_date'First of the Month' | 'First of the Month Next Following' | 'Immediate' | 'Semi-Annual' | 'Quarterly' | '15th of the Month' | 'First of the Month (Coinciding)'

The entry date of the eligibility.

term_date'End of the Month' | 'End of Second Month' | 'Immediate' | '15th of the Month'

The termination date of the eligibility.

rate_typestring

The type of rates.

rate_age_band_typestring

The age band type used for the rates.

tax'Pre-Tax' | 'Post-Tax'

The Tax treatment of the eligibility.

is_spouse_eligibleboolean

Indicates if the spouse eligible for coverage.

is_different_gender_partner_eligibleboolean

Indicates if different gender partner eligible for coverage.

is_same_gender_partner_eligibleboolean

Indicates if same gender partner eligible for coverage.

is_child_eligibleboolean

Indicates if children are eligible for coverage.

Example request

{
  "entry_date": "yyyy-MM-dd",
  "term_date": "yyyy-MM-dd"
}

Response

No Content

Changes