API End Points

Patch Succession Plan Successor

patch
https://apiv2.{domain}.ai/api/v2/careerhub/succession_plans//successors/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Eightfold position ID associated with the succession plan

integer
required

Eightfold decoded profile ID (numeric) of the successor

Body Params
int32 | null

Order of the successor within its succession state group

int32 | null

Eightfold decoded profile ID (numeric)

string | null

ATS/HRIS employee ID of the successor

string | null

Succession state of the successor

Headers
string
required

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

Response

Updated 14 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago