v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Compensation Benchmarking

Public API

Update Compensation Benchmark

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.

OAuth Scopes: compensation_benchmarks.write

put/api/v1/compensation/benchmarks

Request body

idstring required

ID of the benchmark to update.

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. Omitting this field clears data_year on the stored benchmark, so callers updating a Mercer benchmark should resend the existing value.

externalCountrystring

externalSecondaryLocationstring

externalCompanySizestring

externalIndustrystring

Response

Object containing the saved benchmark row and a status message.

messagestring