Update an employee benefit

PUT {{baseUrl}}/v1/employee_benefits/:employee_benefit_id

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:write

Request Body

{"version"=>"<string>", "active"=>"<boolean>", "employee_deduction"=>"0.00", "deduct_as_percentage"=>"<boolean>", "employee_deduction_annual_maximum"=>"<string>", "contribution"=>{"type"=>"<string>", "value"=>"<string>"}, "elective"=>false, "company_contribution_annual_maximum"=>"<string>", "limit_option"=>"<string>", "catch_up"=>false, "coverage_amount"=>"<string>", "deduction_reduces_taxable_income"=>"unset", "coverage_salary_multiplier"=>"0.00", "company_contribution"=>"0.00", "contribute_as_percentage"=>false}

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;version&quot;:&quot;09j3d29jqdpj92109j9j2d90dq&quot;,&quot;employee_uuid&quot;:908123091820398,&quot;company_benefit_uuid&quot;:&quot;54e37c27-43e6-4ae5-a5b2-e29895a133be&quot;,&quot;active&quot;:true,&quot;uuid&quot;:&quot;e91ca856-a915-4339-9b18-29f9cd66b031&quot;,&quot;employee_deduction&quot;:&quot;100.00&quot;,&quot;employee_deduction_annual_maximum&quot;:&quot;200.00&quot;,&quot;company_contribution_annual_maximum&quot;:&quot;200.00&quot;,&quot;limit_option&quot;:null,&quot;deduct_as_percentage&quot;:false,&quot;catch_up&quot;:false,&quot;coverage_amount&quot;:null,&quot;deduction_reduces_taxable_income&quot;:null,&quot;coverage_salary_multiplier&quot;:&quot;0.00&quot;,&quot;contribution&quot;:{&quot;type&quot;:&quot;amount&quot;,&quot;value&quot;:&quot;100.00&quot;}}