BAbamboohr
Pay Grades & Bands
Public API

Delete Compensation Level Groups or Level

Changed on

Deletes compensation level configuration, with the behavior chosen by the {segment} path value. When {segment} is a group status (draft, published, or historic), every compensation level group in that status is deleted and the response is the object {"status":"success"}; deleting draft discards all in-progress edits and is the way to reset the working draft. When {segment} is a numeric compensation level ID, only that single level is deleted and the response is the updated groups-and-levels hierarchy, the same object shape returned by List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels). Deleting a numeric level ID that does not exist is a no-op that returns 200 with the unchanged hierarchy. The accepted {segment} values are the group lifecycle statuses draft, published, and historic, or a numeric level ID. Discover level IDs with List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels). Edit level and group structure with Update Compensation Level Groups and Levels (update-compensation-level-groups-and-levels), and promote draft changes to published with Publish Draft Compensation Level Groups (publish-draft-compensation-level-groups). This operation mutates the stored configuration directly and cannot be undone.

OAuth Scopes: pay_grades_and_bands.write

delete/api/v1/pay-grades-and-bands/levels/{segment}

Request

Path parameters

segmentstring required
Example:draft

Selects what to delete. A group status (draft, published, or historic) deletes all compensation level groups in that status; a numeric compensation level ID deletes that single level. Any other value returns 400.

Response

Deletion succeeded. For a group-status segment the body is {"status":"success"}. For a numeric level-ID segment the body is the updated compensation level groups-and-levels hierarchy.

OR

Example response

{
  "status": "success"
}

Changes

  • 922fc15f43a7Revision changes
    • breaking

      added subschema #1: PayGradesAndBandsDeleteGroupsResponse subschema #2: PayGradesAndBandsDeleteLevelResponse to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • info

      api operation id 0da9c9f851462d2e44dfe866b8e67e74 removed and replaced with delete-compensation-level-groups-or-level

    • info

      api tag Pay Grades & Bands added

    • info

      removed the non-success response with the status