v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
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}

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