DocumentationAPI Reference
API Reference

Create Compensation Benchmark

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

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.

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

ID of the company job title the benchmark applies to.

string

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

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.

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