Update an employee rehire

put https://api.gusto-demo.com/v1/employees/{employee_id}/rehire

Update an employee's rehire.

scope: employments:write

Path Params

employee_id

string

required

The UUID of the employee

Body Params

version

string

required

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

effective_date

string

required

The day when the employee returns to work.

file_new_hire_report

boolean

required

The boolean flag indicating whether Gusto will file a new hire report for the employee.

work_location_uuid

string

required

The uuid of the employee's work location.

employment_status

string

The employee's employment status. Supplying an invalid option will set the employment_status to not_set.

two_percent_shareholder

boolean

Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type.

Headers

X-Gusto-API-Version

string

Defaults to 2024-04-01

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

Responses

Response body

object

version

string

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

effective_date

string

The day when the employee returns to work.

file_new_hire_report

boolean

The boolean flag indicating whether Gusto will file a new hire report for the employee.

work_location_uuid

string

The uuid of the employee's work location.

employment_status

string

The employee's employment status. Supplying an invalid option will set the employment_status to not_set.

part_time full_time part_time_eligible variable seasonal not_set

two_percent_shareholder

boolean

Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type.

employee_uuid

string

The UUID of the employee.

active

boolean

Whether the employee's rehire has gone into effect.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.

xxxxxxxxxx
curl --request PUT \
     --url https://api.gusto-demo.com/v1/employees/employee_id/rehire \
     --header 'X-Gusto-API-Version: 2024-04-01' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "file_new_hire_report": true
}
'

xxxxxxxxxx
 
{
  "version": "2e930d43acbdb241f8f14a2d531fa417",
  "employee_uuid": "da441196-43a9-4d23-ad5d-f37ce6bb99c0",
  "active": false,
  "effective_date": "2024-01-01",
  "file_new_hire_report": false,
  "work_location_uuid": "d2c80d44-857b-4d4d-bce4-23ae52cc863b,",
  "two_percent_shareholder": false,
  "employment_status": "full_time"
}

200Example response

404Not Found The requested resource does not exist. Make sure the provided UUID is valid. The employee's employment is not in the right state.

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.

`invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the Errors Categories guide for more details.