Complete compensation planning cycle

Complete a compensation planning cycle and finalize employee compensation records.

OAuth Scopes: planning_cycles.write

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

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/complete/put.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

Cycle completed successfully

cycleIdinteger

updatedEmployeesCountinteger

cycleClosedEmailErrorstring nullable

Present when cycle completed successfully but sending closed-cycle emails failed

Nov 3, 2026922fc15f43a7 Revision changes
- info
  api operation id f4b431363af6573af46750f32632e88b removed and replaced with 73745fcff2cb909d2690c063474d3e4a