Update a company benefit

PUT {{baseUrl}}/v1/company_benefits/:company_benefit_id

Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.

Note that company benefits can be deactivated only when no employees are enrolled.

scope: company_benefits:write

Request Body

{"version"=>"<string>", "active"=>"<boolean>", "description"=>"<string>"}

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;uuid&quot;:&quot;d2cec746-caee-464a-bcaf-00d93f7049c9&quot;,&quot;version&quot;:&quot;98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872&quot;,&quot;company_uuid&quot;:&quot;881ce3f2-e3e1-49c9-8ad4-0bcf515f5618&quot;,&quot;benefit_type&quot;:1,&quot;active&quot;:true,&quot;description&quot;:&quot;Kaiser Permanente&quot;,&quot;deletable&quot;:true,&quot;supports_percentage_amounts&quot;:true,&quot;responsible_for_employer_taxes&quot;:false,&quot;responsible_for_employee_w2&quot;:false}