Create Phishing Campaign

Create a new phishing campaign.

External Documentation

To learn more, visit the KnowBe4 Security Awareness Training documentation.

Basic Parameters

Parameter	Description
Campaign Name	The name of the campaign to create.
Campaign Type	The type of campaign.
Frequency Period	The running frequency of the campaign.
Localized Campaign	Select whether the campaign is localized.
Next Run	The next run date and time of the phishing campaign.
Selected Group IDs	A comma-separated list of group IDs to target (e.g., 101,102).
Spread Emails	Select whether to spread the emails.
Time Zone	The timezone of the phishing campaign.

Advanced Parameters

Parameter	Description
Business Days	The number of business days of the phishing campaign.
Business Hours End Hour	The business hours end time of the phishing campaign in 24H format.
Business Hours Start Hour	The business hours start time of the phishing campaign in 24H format.
Callback Phishing Greeting Template Translation UUID	The callback phishing greeting template translation UUID.
Callback Phishing Phone Number Region	The callback phishing phone number region.
Clicked Group ID	The ID of the clicked group.
Email Template ID	The ID of the email template.
Email Template Translation UUID	The email template translation UUID.
Hide From Reports	Select whether to hide the phishing campaign from reports.
Is SEI Enabled	Select whether the security indicators are enabled.
Landing Page ID	The ID of the landing page.
Next Run Date	The next run date of the phishing campaign (if providing date and time separately).
Next Run Time	The next run time of the phishing campaign (if providing date and time separately) in 24H format.
Override Phishing Languages	The language to override in the phishing languages.
Phishing Domain ID	The ID of the phishing domain.
Rating	The sophistication rating of the phishing campaign.
Reply Domain Prefix	The prefix of the domain to reply to.
Reply Phish Domain ID	The ID of the domain to reply to.
Selected Template Categories	The selected phishing template categories.
Selected Template Topics	The selected phishing template topics.
Send Email After Run	Select whether to send email after the run.
Sending Duration	The numeric value for the sending duration.
Sending Duration Units	The sending duration units.
Store Full Callback Phone Number	Select whether to store the full callback phone number.
Store Reply Content	Select whether to store reply content.
Template Selection	The template selection of the phishing campaign.
Track Out Of Office Replies	Select whether to store out of office replies.
Track Replies	Select whether to track replies.
Tracking Duration	The tracking duration of the phishing campaign as numeric value.
Tracking Duration Units	The 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

Preview this Workflow on desktop