GUgusto
Employees

Update the employee's 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

put/v1/employees/{employee_id}/onboarding_status

Request

Path parameters

employee_idstring required

The UUID of the employee

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' | 'self_onboarding_pending_invite' | 'self_onboarding_invited' | 'self_onboarding_invited_started' | 'self_onboarding_invited_overdue' | 'self_onboarding_completed_by_employee' | 'self_onboarding_awaiting_admin_review' | 'onboarding_completed' required

Onboarding status value

Response

successful

uuidstring required

Unique identifier for this employee.

onboarding_statusstring

One of the "onboarding_status" enum values.

Changes

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