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)

Language

Credentials

Bearer

Click Try It! to start a request and see the response here!