Skip to main content
Create a new phishing campaign.
External DocumentationTo learn more, visit the KnowBe4 Security Awareness Training documentation.

​
Basic Parameters

ParameterDescription
Campaign NameThe name of the campaign to create.
Campaign TypeThe type of campaign.
Frequency PeriodThe running frequency of the campaign.
Localized CampaignSelect whether the campaign is localized.
Next RunThe next run date and time of the phishing campaign.
Selected Group IDsA comma-separated list of group IDs to target (e.g., 101,102).
Spread EmailsSelect whether to spread the emails.
Time ZoneThe timezone of the phishing campaign.

​
Advanced Parameters

ParameterDescription
Business DaysThe number of business days of the phishing campaign.
Business Hours End HourThe business hours end time of the phishing campaign in 24H format.
Business Hours Start HourThe business hours start time of the phishing campaign in 24H format.
Callback Phishing Greeting Template Translation UUIDThe callback phishing greeting template translation UUID.
Callback Phishing Phone Number RegionThe callback phishing phone number region.
Clicked Group IDThe ID of the clicked group.
Email Template IDThe ID of the email template.
Email Template Translation UUIDThe email template translation UUID.
Hide From ReportsSelect whether to hide the phishing campaign from reports.
Is SEI EnabledSelect whether the security indicators are enabled.
Landing Page IDThe ID of the landing page.
Next Run DateThe next run date of the phishing campaign (if providing date and time separately).
Next Run TimeThe next run time of the phishing campaign (if providing date and time separately) in 24H format.
Override Phishing LanguagesThe language to override in the phishing languages.
Phishing Domain IDThe ID of the phishing domain.
RatingThe sophistication rating of the phishing campaign.
Reply Domain PrefixThe prefix of the domain to reply to.
Reply Phish Domain IDThe ID of the domain to reply to.
Selected Template CategoriesThe selected phishing template categories.
Selected Template TopicsThe selected phishing template topics.
Send Email After RunSelect whether to send email after the run.
Sending DurationThe numeric value for the sending duration.
Sending Duration UnitsThe sending duration units.
Store Full Callback Phone NumberSelect whether to store the full callback phone number.
Store Reply ContentSelect whether to store reply content.
Template SelectionThe template selection of the phishing campaign.
Track Out Of Office RepliesSelect whether to store out of office replies.
Track RepliesSelect whether to track replies.
Tracking DurationThe tracking duration of the phishing campaign as numeric value.
Tracking Duration UnitsThe units of the tracking duration units of the phishing campaign.

​
Example Output

{
	"data": {
		"phishingCampaignCreate": {
			"errors": [],
			"node": {
				"id": "12345",
				"name": "Q3 Phishing Test",
				"active": true,
				"campaignType": "STANDARD",
				"frequencyPeriod": "ONETIME",
				"selectedGroups": [
					101,
					102
				],
				"createdAt": "2023-10-01T12:00:00Z"
			}
		}
	}
}

​
Workflow Library Example

Create Phishing Campaign with Knowbe4 Security Awareness Training and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop