band

Update a comp band

patch/v1/org/{orgId}/band/{bandId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/band/{bandId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

bandIdstring required

Band id

Query parameters

datestring date

Effective date of band update

Request body

labelstring required

human-readable name of content

colorstring required

hex color associated with the band level

baseSpreadnumber

spread percent used to calculate base comp from the midpoint

baseTargetPayPercentilenumber

base target pay associated with open jobs at this band level, as a percentile

equityTargetSharesnumber

target equity for the band, in shares

equityTargetPercentOfBasenumber

target equity for the band, as a percentage of base

equityTargetValuenumber

target equity for the band, as a monetary value, in the same currency as the base

equityRefreshSharesnumber

refresh grant equity for the band, in shares

equityRefreshPercentOfBasenumber

refresh grant equity for the band, as a percentage of base

equityRefreshValuenumber

refresh grant equity for the band, as a monetary value, in the same currency as the base

variablePercentOfBasenumber

variable compensation for the band, specified as a percentage of base

jobLevelstring

job level associated with the comp band

Example request

{
  "label": "L15",
  "color": "#ffee4a",
  "baseInterval": {
    "id": "588f7ee98f138b19220041a7"
  },
  "jobLevel": "588f7ee98f138b19220041a7"
}

Response

snapshot currently building

Changes

No recorded changes to this operation across all 22 revisions of this API.