BAbamboohr
Compensation Benchmarking
Public API

Create Compensation Benchmark

Creates a new compensation benchmark for a specific company job title (and optionally a specific job location). The jobTitleId value comes from GET /api/v1/compensation/benchmarks (jobDetails.id) or the company's job-title list. When jobLocationId is omitted, the benchmark applies to the job title at any location. Returns the saved benchmark wrapped in savedBenchmark along with a status message.

OAuth Scopes: compensation_benchmarks.write

post/api/v1/compensation/benchmarks

Request

Request body

jobTitleIdstring required

ID of the company job title the benchmark applies to.

jobLocationIdstring

Optional job location ID to scope the benchmark to a specific location.

currencyCodestring required

ISO 4217 currency code for the benchmark values.

mjlJobCodestring

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

benchmarkValuenumber required

Benchmark median value.

benchmarkMinnumber required

Benchmark minimum value.

benchmarkMaxnumber required

Benchmark maximum value.

benchmarkSourcestring

Free-text label describing where the benchmark came from.

externalJobTitlestring
externalLocationstring
externalLevelstring
externalJobDescriptionstring
companiesSurveyedinteger
employeesSurveyedinteger
sourceIdstring

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

sourceDatestring

Date the benchmark source data applies to.

dataYearstring

Year of the underlying survey data.

externalCountrystring
externalSecondaryLocationstring
externalCompanySizestring
externalIndustrystring

Response

Object containing the newly created benchmark row and a status message.

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.