v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Succession Plan

Patch Succession Plan

Update existing succession plan's metadata. Refer to request schema for fields that can be updated. For updating successors and caretakers, please use the dedicated successor and caretaker endpoints. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

patch/api/v2/careerhub/succession_plans/{positionId}

Path parameters

positionIdinteger required

Eightfold position ID associated with the succession plan

Headers

Authorizationstring required

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

Request body

planNamestring nullable

Name of the succession plan

descriptionstring nullable

Description of the succession plan

positionCriticalityTagsstring[] nullable

Criticality tags of the succession plan that is associated with the position held by the incumbent

Response

createdAtinteger nullable

Timestamp representing creation date and time of the succession plan

associatedRoleIdstring nullable

Eightfold role ID associated with the succession plan

jobCodestring nullable

External job code of the incumbent(s)

entityIdstring nullable

ATS/HRIS position ID associated with the plan

positionCriticalityTagsstring[] nullable

Criticality tags of the succession plan that is associated with the position held by the incumbent

planTypestring nullable

Type of the succession plan Ex. either "position" or "role" (only honored for POST)

planNamestring nullable

Name of the succession plan

updatedAtinteger nullable

Timestamp representing the updation date and time of the succession plan

roleCriticalityTagsstring[] nullable

Criticality tags of the role that is associated with the position held by the incumbent

positionIdinteger required

Eightfold position ID associated with the succession plan

descriptionstring nullable

Description of the succession plan