Create a training campaign

post

https://api.caniphish.com/api/v3/campaigns/create-training-campaign

Creates a training-only campaign that assigns training modules to the targeted employees. Fails if a campaign with the same name already exists.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Optional future scheduling for a training-only campaign.

tenantID

string

required

campaignName

string

required

Unique campaign name. Sanitized server-side (apostrophes/periods/special chars become hyphens).

targetUsers

array of strings

Names of the employee lists to target.

targetUsers

continuousSync

boolean

Continuously sync employee lists into the campaign.

campaignTags

array of strings

campaignTags

trainingModules

array of strings

Training module names (train / phishTrain).

trainingModules

autoTrain

boolean

Enterprise only. When true, the AI Program Manager auto-selects training modules per employee at assignment time — omit trainingModules. A non-Enterprise tenant that sets this receives 403 ENTITLEMENT_REQUIRED.

autoTrainPrompt

string

Guidance (max 500 chars) steering per-employee auto-train module selection. Recommended to supply. If omitted, the platform applies the default: "Select whichever training modules are most contextually appropriate for each individual employee based on their role, prior training history, demonstrated skill level, and any recent phishing interactions."

trainingFreq

string

enum

How often the training recurs. "once" = a single assignment.

Allowed:

trainingDueDays

integer

Defaults to 14

trainingRandomised

string

enum

"allTrainings" assigns every selected module; "randomTraining" lets CanIPhish intelligently assign a module per employee. (Any value other than "allTrainings" is treated as randomTraining.)

Allowed:

trainingLang

string

ISO culture or "dynamic".

tExpiry

string

Training expiry "MMM dd, yyyy" (capped at 4 years).

trainingSchedule

boolean

Schedule training to start at a future date/time (train type).

trainingDate

string

Training start date "MMM dd, yyyy" (when trainingSchedule is true).

trainingTime

string

Training start time "HH:mm".

trainingTZ

string

IANA time zone for scheduled training.

Responses

Language

Credentials

Loading…

Response

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

application/json

200Campaign saved.

400Validation or authentication error.