DocumentationAPI Reference
API Reference

Update Compensation Benchmark

put
https://{companyDomain}.bamboohr.com/api/v1/compensation/benchmarks

Updates an existing compensation benchmark identified by id. The id of an existing benchmark can be obtained from GET /api/v1/compensation/benchmarks/details. Request fields that are omitted or null are cleared on the stored benchmark; callers should send the full benchmark payload to preserve values. On success, returns the saved benchmark row wrapped in savedBenchmark together with a status message.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID of the benchmark to update.

string
required

ISO 4217 currency code for the benchmark values.

string

Mercer Job Library code associated with this benchmark. Stored on the benchmark as mercerJobCode.

number
required

Benchmark median value.

number
required

Benchmark minimum value.

number
required

Benchmark maximum value.

string

Free-text label describing where the benchmark came from.

string
string
string
string
integer
integer
string

ID of the benchmark source from GET /api/v1/compensation/benchmarks/sources.

string

Date the benchmark source data applies to.

string

Year of the underlying survey data. Omitting this field clears data_year on the stored benchmark, so callers updating a Mercer benchmark should resend the existing value.

string
string
string
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 days ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 days ago