---
title: "Set Total Rewards Custom Disclaimer"
method: PUT
path: "/api/v1/compensation/total_rewards/custom_disclaimer"
tags: ["Total Rewards", "Public API"]
---

# Set Total Rewards Custom Disclaimer

`PUT /api/v1/compensation/total_rewards/custom_disclaimer`

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/compensation/total_rewards/custom_disclaimer`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `total_rewards.write`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/total_rewards/custom_disclaimer/put.ts> (a function with typed inputs; its response is checked against the schema)

Set the company-wide Total Rewards custom disclaimer text shown on employee statements.

OAuth Scopes: total_rewards.write

## Request body

- object
  - `customDisclaimer` string, required: Custom disclaimer text.

## Response `200`

Custom disclaimer updated successfully.

## Other responses

- `403`: The authenticated caller lacks permission to manage Total Rewards settings.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)
