Update Upskill Plan Assignment by External Id

patch

https://apiv2.{domain}.ai/api/v2/careerhub/{profileEncId}/upskill-plan-assignment/ext/{externalId}

Update the assigned plan of this profile that has the external Id. Fields in the body replace the stored ones; absent fields are left unchanged. sections is optional. When it is omitted, the plan's sections are unchanged. When it is sent, it replaces all of the plan's sections: afterwards the plan has exactly the sections, courses and tasks in the body. Send [] to remove every section.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileEncId

string

required

Encoded profile id: id from GET /api/v2/core/employees

externalId

string

required

The caller's own id for the plan, unique per profile

Body Params

planSubtype

string | null

Plan subtype, one of the subtypes configured for your account. Defaults to general.

sections

array of objects

sections is optional. When it is omitted, the plan's sections are unchanged. When it is sent, it replaces all of the plan's sections: afterwards the plan has exactly the sections, courses and tasks in the body. Send [] to remove every section.

sections

name

string | null

required

Plan title

planDurationDays

int32 | null

Plan duration in days. Rounded down to whole weeks, at most 693; values under 7 leave it unset.

skills

array of strings

Skill names the plan develops. A task's skills must come from this list.

skills

targetDate

int32 | null

Target completion date (epoch seconds)

description

string | null

Plan description

associatedRoleIds

array of strings

Role ids, as returned by GET /api/v2/JIE/roles.

associatedRoleIds

Headers

Authorization

string

required

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

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK