Compensation Planning

Public API

Launch compensation planning cycle

Changed on Nov 3, 2026

Launch a compensation planning cycle. Validates all cycle data and sets status to Live.

OAuth Scopes: planning_cycles.write

put/api/v1/compensation/planning_cycles/{id}/launch

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopesplanning_cycles.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/planning_cycles/:id/launch/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Response

Cycle launched successfully

Changes

Nov 3, 2026922fc15f43a7 Revision changes
- info
  api operation id 3a19f07aa737dc826ba43b9a1c1cd257 removed and replaced with 23537f8bcc6a4d10d36f1e99709e043d

Operation history