Pay Grades & Bands
Public API

Update Compensation Level Groups and Levels

Changed on

Creates or updates compensation level groups and their levels in the company draft configuration. If no draft exists yet, one is created from the currently published configuration before changes are applied, and published group and level identifiers are mapped to their new draft counterparts. This is a partial upsert. Groups and levels omitted from the request are left unchanged, so it does not overwrite the full set. A group is deleted when its groupName is blank or null and it has no levels. A level is deleted when its levelName is blank or null and a levelId is supplied. Only group and level names and structure are persisted here. The per-level compensationType in the request is not applied by this endpoint; a newly created level derives its compensation type from the group's existing compensation type (or Salary when the group has none), and existing levels keep their compensation type unchanged. Pay band values (min, mid, max, percentageRange, currencyCode) and job-title assignments may be present in the payload but are not saved by this endpoint; set pay band values with Update Pay Bands (update-pay-bands) and set job-title assignments with Replace Job Title Level Assignments (replace-job-title-level-assignments). Changes stay in draft until promoted. Publish them with Publish Draft Compensation Level Groups (publish-draft-compensation-level-groups). Read the current draft back with List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels). On success the response is a JSON object {"status":"success"}.

OAuth Scopes: pay_grades_and_bands.write

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

Request

Request body

Response

Groups and levels saved to the draft configuration. Returns the JSON object {"status":"success"}.

statusstring

Example response

{
  "status": "success"
}

Changes

    • warning

      removed the request property //

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • info

      api operation id 432e469fe5959a6ccd765d02018e7db4 removed and replaced with update-compensation-level-groups-and-levels

    • info

      api tag Pay Grades & Bands added

    • info

      added the new optional request property //

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////