v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Succession Plan

Patch Succession Plan Successor

Patch a successor in the succession plan. The successor's attributes are updated with new data given in the request. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

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

Path parameters

positionIdinteger required

Eightfold position ID associated with the succession plan

profileIdinteger required

Eightfold decoded profile ID (numeric) of the successor

Headers

Authorizationstring required

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

Request body

createdAtinteger nullable

Timestamp when the successor was first added to the plan

orderinteger nullable

Order of the successor within its succession state group

profileIdinteger nullable

Eightfold decoded profile ID (numeric)

employeeIdstring nullable

ATS/HRIS employee ID of the successor

updatedAtinteger nullable

Timestamp when the successor data was last updated

statestring nullable

Succession state of the successor

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