CHcheckhq

Update a benefit

Changed on

Updates the specified benefit.

patch/benefits/{benefit}

Request

Path parameters

benefitstring required

ID of the benefit to update

Request body

employeestring

Update the benefit for this employee

benefitstring

Type of supported benefit. See types of benefits.

company_benefitstring

The company benefit to associate this employee benefit with.

periodstring

The period over which a period amount is distributed. Can be "monthly" or null.

descriptionstring

Optional description to distinguish the benefit within the plan. Maximum length of 255 characters.

company_contribution_amountstring

Amount for company to contribute per payroll

company_contribution_percentnumber float

Decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

company_period_amountstring

Amount for company to contribute over period.

employee_contribution_amountstring

Amount for employee to contribute per payroll

employee_contribution_percentnumber float

Decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

employee_period_amountstring

Amount for employee to contribute over period.

effective_startstring date

Start date for the benefit

effective_endstring date

End date for the benefit

hsa_contribution_limitstring

Contribution limit of a HSA benefit

metadatastring json

Additional loosely structured information to associate with this employee benefit

Response

200

object required

Changes