EIeightfold
Position

Patch Position

Changed on

Given a position id and data that needs to be patched, it patches the position. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

patch/api/v2/core/positions/{positionId}

Request

Path parameters

positionIdstring required

EF Entity ID of position

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Request body

createdAtinteger nullable

Creation timestamp in epoch format

jobDescriptionUpdatedAtinteger nullable

Epoch timestamp (seconds) of the last job description write in Eightfold. Null when the job description has only ever come from the ATS. 0 when Eightfold edit was superseded by an inbound ATS job description change, on tenants where the ATS job description takes precedence.

confidentialboolean nullable

if the position is confidential or not

groupIdstring nullable

group id

namestring nullable required

Title of the Position

followersstring[] nullable

all the followers of the position

jobDescriptionstring nullable

Detailed Job Description in a text format

systemIdstring nullable

system id

positionDisplayIdstring nullable

display job id

calibrationConfirmedBystring nullable

User who confirmed the calibration

openboolean nullable

True while the position record exists (not archived or deleted). Not the recruiting status - use atsData.status for the open/closed hiring lifecycle.

createdBystring nullable

source of the job

calibrationConfirmedAtinteger nullable

Confirmed timestamp for the calibration

positionIdinteger nullable

job id

Response

OK

createdAtinteger nullable

Creation timestamp in epoch format

jobDescriptionUpdatedAtinteger nullable

Epoch timestamp (seconds) of the last job description write in Eightfold. Null when the job description has only ever come from the ATS. 0 when Eightfold edit was superseded by an inbound ATS job description change, on tenants where the ATS job description takes precedence.

confidentialboolean nullable

if the position is confidential or not

groupIdstring nullable

group id

namestring nullable required

Title of the Position

followersstring[] nullable

all the followers of the position

jobDescriptionstring nullable

Detailed Job Description in a text format

systemIdstring nullable

system id

positionDisplayIdstring nullable

display job id

calibrationConfirmedBystring nullable

User who confirmed the calibration

openboolean nullable

True while the position record exists (not archived or deleted). Not the recruiting status - use atsData.status for the open/closed hiring lifecycle.

createdBystring nullable

source of the job

calibrationConfirmedAtinteger nullable

Confirmed timestamp for the calibration

positionIdinteger nullable

job id

Changes