Create a training module

Creates a new custom training module for the tenant. Rejects names already used by a custom module or a platform library module — to customise a platform module use update-training-module, or copy it under a new name with duplicate-training-module.

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

Passing grade percentage.

integer
1 to 120
Defaults to 5

Estimated completion minutes (server clamps to 1–120; defaults to 5 when omitted).

string

Culture code (default en).

string
enum
Allowed:
string
enum

Sets the module's own difficulty rating (console label: "Skill Level"); it does not target or filter learners. skillLevel is accepted as an alias for this same field for clarity — if both are supplied, learnerSkill wins.

Allowed:
string
enum

Alias for learnerSkill (module difficulty rating, console label "Skill Level"). Ignored if learnerSkill is also supplied.

Allowed:
string

Screenshot / thumbnail URL. Defaults to a standard CanIPhish training image when omitted.

string
complianceMapping
array of strings
complianceMapping
tags
array of strings
tags
pages
array of objects
required

Ordered list of question/statement pages.

pages*
Responses

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