These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Update a company benefit

put

https://api.gusto-demo.com/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

Path Params

company_benefit_id

string

required

The UUID of the company benefit

Body Params

version

string

required

The current version of the object. See the versioning guide for information on how to use this field.

active

boolean

Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating.

description

string

The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.

Headers

X-Gusto-API-Version

string

enum

Defaults to 2024-03-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Example response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.