Delete Compensation Level Groups or Level

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

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

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.

Responses

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