v1
latestOpenAPI 3.1.02026-07-243113441.2 MBContractors
Change the contractor's onboarding status
Updates a contractor's onboarding status.
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 |
scope: contractors:write
put/v1/contractors/{contractor_uuid}/onboarding_status
Path parameters
contractor_uuidstring required
The UUID of the contractor
Headers
X-Gusto-API-Version'2026-06-15'
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Request body
Response
Successful