DocumentationAPI Reference
API Reference

Set Total Rewards Onboarding Step Status

put
https://{companyDomain}.bamboohr.com/api/v1/compensation/total_rewards/onboarding/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Name of the onboarding step.

Body Params
boolean
required

Whether the step is completed.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 8 hours ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 8 hours ago