---
title: "Update compensation planning cycle"
method: PUT
path: "/api/v1/compensation/planning_cycles/{id}"
tags: ["Compensation Planning", "Public API"]
---

# Update compensation planning cycle

`PUT /api/v1/compensation/planning_cycles/{id}`

Update compensation planning cycle details and currency settings.

OAuth Scopes: planning_cycles.write

## Path parameters

- `id` integer, required

## Request body

- DetailsAndCurrencyRequestDataObject — Request data for updating compensation planning cycle details and currency settings. Pre-condition: User must have permission to update cycle. Post-condition: Cycle configuration is updated.
  - `id` string — ID of the cycle to update
  - `cycleName` string — Name of the cycle to update
  - `cycleCurrency` string, nullable — Currency code for the cycle
  - `cycleWindowStartYmd` string, date — Start date of the cycle window
  - `cycleWindowEndYmd` string, date — End date of the cycle window
  - `recommendationsDueYmd` string, date — Date when recommendations are due
  - `approvalsDueYmd` string, date — Date when approvals are due
  - `cycleEffectiveDate` string, date — Effective date of the cycle
  - `salaryIncluded` boolean — Whether salary is included in this cycle
  - `bonusIncluded` boolean — Whether bonus is included in this cycle
  - `equityIncluded` boolean — Whether equity is included in this cycle
  - `cycleCurrencyConversionRates` ConversionRateDataObject[] — Currency conversion rates
    - `currencyName` string — The full name of the target currency.
    - `currencyCode` string — The code of the target currency (e.g. USD, EUR, JPY).
    - `conversionRate` number, float — The numeric conversion rate to the target currency.
  - `paycheckDateYmd` string, date — Date of first paycheck with new compensation updates

## Response `200`

Cycle updated successfully

- object

## Other responses

- `400` — Invalid request data
- `403` — Insufficient permissions
- `404` — Resource not found
- `500` — Internal 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/revisions/19ebf391a399/schema)