v3

latestSwagger 2.02026-08-067506752.0 MB

comp-review

Update a comp review

patch/v1/org/{orgId}/comp-review/{compReviewId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Review id

Request body

labelstring

human-readable label of goal

Whether the compensation review has been approved by the final approvers

reviewerCountinteger

count of reviewers in the comp review

submittedCountinteger

count of reviews that have been submitted and approved

Example request

{
  "label": "Comp review H2 2022",
  "config": {
    "eligibleEmployees": {
      "excludeGroupIds": [
        "588f7ee98f138b19220041a7"
      ],
      "individualExclusions": [
        "588f7ee98f138b19220041a7"
      ],
      "individualInclusions": [
        "588f7ee98f138b19220041a7"
      ]
    },
    "reviewersAndApprovers": {
      "excludedReviewerIds": [
        "588f7ee98f138b19220041a7"
      ],
      "approverIds": [
        "588f7ee98f138b19220041a7"
      ]
    },
    "collaborators": {
      "collaboratorJobIds": [
        "588f7ee98f138b19220041a7"
      ],
      "collaboratorMatrix": {
        "conditions": [
          {
            "collaboratorJobIds": [
              "588f7ee98f138b19220041a7"
            ]
          }
        ]
      }
    },
    "reviewerWorkbook": {
      "columns": [
        {
          "visibleToGroups": [
            "588f7ee98f138b19220041a7"
          ]
        }
      ]
    },
    "budgets": {
      "totalBudgetVisibilityPersonIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  },
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ]
}

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

labelstring required

human-readable label of goal

Whether the compensation review has been approved by the final approvers

reviewerCountinteger

count of reviewers in the comp review

submittedCountinteger

count of reviews that have been submitted and approved

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "label": "Comp review H2 2022",
  "config": {
    "eligibleEmployees": {
      "excludeGroupIds": [
        "588f7ee98f138b19220041a7"
      ],
      "individualExclusions": [
        "588f7ee98f138b19220041a7"
      ],
      "individualInclusions": [
        "588f7ee98f138b19220041a7"
      ]
    },
    "reviewersAndApprovers": {
      "excludedReviewerIds": [
        "588f7ee98f138b19220041a7"
      ],
      "approverIds": [
        "588f7ee98f138b19220041a7"
      ]
    },
    "collaborators": {
      "collaboratorJobIds": [
        "588f7ee98f138b19220041a7"
      ],
      "collaboratorMatrix": {
        "conditions": [
          {
            "collaboratorJobIds": [
              "588f7ee98f138b19220041a7"
            ]
          }
        ]
      }
    },
    "reviewerWorkbook": {
      "columns": [
        {
          "visibleToGroups": [
            "588f7ee98f138b19220041a7"
          ]
        }
      ]
    },
    "budgets": {
      "totalBudgetVisibilityPersonIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  },
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}