GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
Start typing to search…

Change the contractor's onboarding status

put
https://api.gusto-demo.com/v1/contractors//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.

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
Path Params
string
required

The UUID of the contractor

Body Params
string
enum
required
Defaults to onboarding_completed

The updated onboarding status for the contractor

Allowed:
Headers
string
enum
Defaults to 2026-02-01

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

Allowed:
Responses

404

Not Found

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

Updated 4 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago