Update Position

PATCH /positions/{id}

Group: People Management › Positions · Operation ID: updatePosition

Updates the position with the given identifier. Only the fields in the request body change. Use the position's id, not its positionNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the position to update.

Request body

Required, application/json: updatePositionInput.

Field Type Required Description
name string no The display name of the position.
description string no A free-form description of the position's responsibilities.
desiredHeadcount number no The target number of people to fill this position.
expectedSalary number no The expected annual salary for this position, in the entity's currency.
startDate string no The date the position becomes active. Use format YYYY-MM-DD.
endDate string no The date the position becomes inactive. Use format YYYY-MM-DD. It cannot be cleared through this endpoint.
overtimeStatus string, one of "EXEMPT", "NON_EXEMPT" no The overtime eligibility of the position.
hiringManagerId string no The identifier of the employee who is the hiring manager. See id on GET people/:id.
jobProfileId string no The identifier of the job profile the position is associated with. There is no endpoint for it.
regionId string no The identifier of the region the position is based in. There is no endpoint for it.

Example:

{
  "name": "<name>",
  "description": "<description>",
  "desiredHeadcount": 0,
  "expectedSalary": 0,
  "startDate": "<startDate>",
  "endDate": "<endDate>",
  "overtimeStatus": "EXEMPT",
  "hiringManagerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "jobProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "regionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
MANAGER_NOT_FOUND 400
JOB_PROFILE_NOT_FOUND 400
REGION_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses