---
title: "Set Total Rewards Onboarding Step Status"
method: PUT
path: "/api/v1/compensation/total_rewards/onboarding/{stepName}"
tags: ["Total Rewards", "Public API"]
---

# Set Total Rewards Onboarding Step Status

`PUT /api/v1/compensation/total_rewards/onboarding/{stepName}`

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

## Path parameters

- `stepName` string, required

## Request body

- object
  - `completed` boolean, required — Whether the step is completed.

## Response `200`

Onboarding step status updated successfully.

- TotalRewardsOnboardingStep
  - `name` string — Name of the onboarding step
  - `completed` boolean — Whether or not the onboarding step is completed

## Other responses

- `400` — Invalid argument (e.g. invalid step name or non-boolean completed value).
- `403` — The authenticated caller lacks permission to manage Total Rewards onboarding.
- `500` — Unexpected server error.

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/versions/19ebf391a399/schema)