EIeightfold
Upskill Plan Template

Update Upskill Plan Template

Changed on

Update an upskilling plan template. 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.

patch/api/v2/careerhub/upskill-plan-templates/{planId}

Request

Path parameters

planIdstring required

Plan id: id from the GET or list response

Headers

Authorizationstring required

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

Request body

statusstring nullable

Template status: draft | published

planSubtypestring nullable

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

namestring nullable required

Plan title

planDurationDaysinteger nullable

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

skillsstring[]

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

descriptionstring nullable

Plan description

associatedRoleIdsstring[]

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

Response

OK

statusstring nullable

Template status: draft | published

idinteger nullable

Template plan id

createdAtinteger nullable

Created timestamp (epoch seconds)

planSubtypestring nullable

Plan subtype

namestring nullable

Plan title

externalIdstring nullable

Your external record id, unique in the tenant. Addresses the plan in the /ext/<externalId> paths.

userIdstring nullable

Plan creator user id

planDurationDaysinteger nullable

Plan duration in days

publishedAtinteger nullable

Publish timestamp (epoch seconds)

skillsstring[] nullable

Skill names

groupIdstring nullable

Tenant group id

updatedAtinteger nullable

Updated timestamp (epoch seconds)

descriptionstring nullable

Plan description

associatedRoleIdsstring[] nullable

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

Changes