GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Update the employee's onboarding status

scope: employees:manage

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
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!