Create Upskill Plan Template

post

https://apiv2.{domain}.ai/api/v2/careerhub/upskill-plan-templates

Create an upskilling plan template from an external system. Published unless status says otherwise. 409 with the existing planId if externalId already exists in the tenant. sections is optional. When it is omitted, the plan is created with one empty section.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

status

string | null

Template status: draft | published. Defaults to published.

externalId

string | null

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

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 is created with one empty 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.

creatorProfileId

string | null

Encoded profile id of the plan creator, from GET /api/v2/core/employees. Must be a user who can sign in; the creator can edit the plan. Required for API-key callers. A signed-in caller is the creator: omit it, or send your own id.

skills

array of strings

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

skills

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