GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Update the employee's onboarding status

put
https://api.gusto-demo.com/v1/employees//onboarding_status

Updates an employee's onboarding status. Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the employee.

Actioncurrent onboarding_statusnew onboarding_status
Mark an employee as self-onboardingadmin_onboarding_incompleteself_onboarding_pending_invite
Invite an employee to self-onboardadmin_onboarding_incomplete or self_onboarding_pending_inviteself_onboarding_invited
Cancel an employee's self-onboardingself_onboarding_invited or self_onboarding_pending_inviteadmin_onboarding_incomplete
Review an employee's self-onboarded infoself_onboarding_completed_by_employeeself_onboarding_awaiting_admin_review
Finish an employee's onboardingadmin_onboarding_incomplete or self_onboarding_awaiting_admin_reviewonboarding_completed

scope: employees:manage

Path Params
string
required

The UUID of the employee

Body Params
string
enum
required

Onboarding status value

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

Updated 6 days ago

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

Updated 6 days ago