Change the contractor's onboarding status

put https://api.gusto-demo.com/v1/contractors/{contractor_uuid}/onboarding_status

Updates a contractor's onboarding status.

scope: contractors:write

Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the contractor.

Action	current onboarding_status	new onboarding_status
Mark a contractor as self-onboarding	`admin_onboarding_incomplete`	`self_onboarding_not_invited`
Invite a contractor to self-onboard	`admin_onboarding_incomplete` or `self_onboarding_not_invited`	`self_onboarding_invited`
Cancel a contractor's self-onboarding	`self_onboarding_invited` or `self_onboarding_not_invited`	`admin_onboarding_incomplete`
Review a contractor's self-onboarded info	`self_onboarding_started`	`self_onboarding_review`
Finish a contractor's onboarding	`admin_onboarding_review` or `self_onboarding_review`	`onboarding_completed`

📘
When contractor is fully onboarded
The new hire report will be generated using the current data (work_state) (if contractor file_new_hire_report is set true)

Responses

404

Not Found

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

`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/contractors/contractor_uuid/onboarding_status \
     --header 'X-Gusto-API-Version: 2024-04-01' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "onboarding_status": "onboarding_completed"
}
'

xxxxxxxxxx
}
{
  "uuid": "bc57832c-d8bc-43a7-ae99-3a03380ff037",
  "onboarding_status": "admin_onboarding_incomplete",
  "onboarding_steps": [
    {
      "title": "Basic details",
      "id": "basic_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Enter compensation details",
      "id": "compensation_details",
      "required": true,
      "completed": false,
      "requirements": []
    },
    {
      "title": "Add an address",
      "id": "add_address",
      "required": true,
      "completed": false,
      "requirements": []
    },

📘

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.

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