Pay Grades & Bands
Public API

Update Pay Bands

Changed on

Updates the pay band values (min, mid, max, percentageRange) for compensation levels in the company's draft pay grades and bands. This is the only endpoint that persists pay band values; Update Compensation Level Groups and Levels (update-compensation-level-groups-and-levels) defines the group and level structure but does not save band values. Job-title assignments are set separately with Replace Job Title Level Assignments (replace-job-title-level-assignments). Supply the level IDs returned by Get Pay Bands (get-pay-bands). If no draft exists yet, one is created from the published structure and the supplied published level IDs are remapped onto the newly created draft levels, so later reads return draft-specific level IDs. When payBandType is percentRange, min and max are derived from mid and percentageRange and any supplied min/max are ignored; when minMidMax, the supplied min/mid/max are stored and percentageRange is cleared. Every target level must belong to a draft group, otherwise the request fails with 400. Values are written to the draft only; publish them with Publish Draft Compensation Level Groups (publish-draft-compensation-level-groups). Returns an object with a single status field set to success.

OAuth Scopes: pay_grades_and_bands.write

put/api/v1/pay-grades-and-bands/pay-bands

Request

Request body

payBandType'percentRange' | 'minMidMax'

Selects how band values are interpreted. percentRange derives min/max from mid and percentageRange; minMidMax stores the supplied min/mid/max and clears percentageRange. Defaults to minMidMax when omitted.

Response

Pay bands updated. Returns an object with a status field set to success.

statusstring

Example response

{
  "status": "success"
}

Changes

    • breaking

      the request property // became required

    • breaking

      request property // list-of-types was narrowed by removing types null from media type application/json

    • info

      api operation id ad7871529b2a9c6612f8dd3c62192c08 removed and replaced with update-pay-bands

    • info

      api tag Pay Grades & Bands added

    • info

      the request property became optional

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      request property // list-of-types was widened by adding types null to media type application/json

    • info

      request property // list-of-types was widened by adding types null to media type application/json