Account Information13

Alerts5

Applicant Tracking10

Benefits10

Calendar Events1

Change Tracking2

Company Files6

Company Profile3

Compensation3

Compensation Benchmarking11

Compensation Planning28

Custom Fields12

Custom Reports4

Custom Tables7

Datasets8

Employee Files6

Employee Tables6

Employee Verification5

Employees8

Field Metadata4

Goals24

Holidays8

Hours1

Locations5

Login1

Meal & Rest Breaks20

Onboarding12

Pay Grades & Bands14

Photos2

Public API5

Recognition Settings1

Reports2

Scheduling21

Time Off37

Time Tracking63

Total Rewards8

Training12

Webhooks8

Webhooks

Webhook Events6

Total Rewards

Public API

Set Total Rewards Onboarding Step Status

Set a Total Rewards onboarding step to completed or incomplete. Valid step names are defined by the Total Rewards onboarding configuration.

OAuth Scopes: total_rewards.write

put/api/v1/compensation/total_rewards/onboarding/{stepName}

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopestotal_rewards.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/total_rewards/onboarding/:stepName/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

stepNamestring required

Name of the onboarding step.

Request body

completedboolean required

Whether the step is completed.

Response

Onboarding step status updated successfully.

namestring

Name of the onboarding step

completedboolean

Whether or not the onboarding step is completed

Changes

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