GUgusto
Contractors

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.

Actioncurrent onboarding_statusnew onboarding_status
Mark a contractor as self-onboardingadmin_onboarding_incompleteself_onboarding_not_invited
Invite a contractor to self-onboardadmin_onboarding_incomplete or self_onboarding_not_invitedself_onboarding_invited
Cancel a contractor's self-onboardingself_onboarding_invited or self_onboarding_not_invitedadmin_onboarding_incomplete
Review a contractor's self-onboarded infoself_onboarding_startedself_onboarding_review
Finish a contractor's onboardingadmin_onboarding_review or self_onboarding_reviewonboarding_completed

scope: contractors:write

put/v1/contractors/{contractor_uuid}/onboarding_status

Request

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

onboarding_status'admin_onboarding_incomplete' | 'admin_onboarding_review' | 'self_onboarding_not_invited' | 'self_onboarding_invited' | 'self_onboarding_started' | 'self_onboarding_review' | 'onboarding_completed' required

The updated onboarding status for the contractor.

Response

Successful

uuidstring required

Unique identifier for this contractor.

onboarding_status'onboarding_completed' | 'admin_onboarding_review' | 'admin_onboarding_incomplete' | 'self_onboarding_not_invited' | 'self_onboarding_invited' | 'self_onboarding_started' | 'self_onboarding_review'

One of the "onboarding_status" enum values.

Changes

No recorded changes to this operation across all 2 revisions of this API.