Save budget guidelines

Save budget guidelines for a compensation planning cycle.

OAuth Scopes: planning_cycles.write

put/api/v1/compensation/planning_cycles/{id}/budgets/guidelines

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

idinteger required

useGuidelinesboolean

softMinnumber

softMaxnumber

Guidelines saved successfully

useGuidelinesboolean

Whether to use budget guidelines

softMinimumnumber nullable

Soft minimum budget guideline

softMaximumnumber nullable

Soft maximum budget guideline

requireCommentsboolean

Whether a comment is required for recommendations outside of guidelines

Nov 3, 2026922fc15f43a7 Revision changes
- info
  api operation id dacd313af2106213fc4696175941ce65 removed and replaced with ecef4aab811712888dd01a6195a97599