Create a phishing email template

post

https://api.caniphish.com/api/v3/content-library/phishing-emails/create-phishing-email

Creates a new phishing email template from the supplied HTML body and metadata. Rejects names already used by a custom template or a platform library template — to customise a platform template use update-phishing-email, or copy it under a new name with duplicate-phishing-email.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

tenantID

string

required

templateName

string

required

templateDescription

string

emailSubject

string

emailBody

string

HTML body.

targetReqs

array of strings

Target data fields this template requires, using the console's internal codes: preEmail=Email Address, preFName=First Name, preLName=Last Name, preCompany=Company, preJTitle=Job Title, preSupervisor=Supervisor Email, preCountry=Country, prePhone=Phone Number. Returned back (as a boolean object keyed by the plain field names) in getPhishingEmail's RequiredInfo.

targetReqs

files

array of objects

File attachments / resources. Each entry pairs a fileType with a fileStorage URL. These are the same key names getPhishingEmail returns in EmailFiles[], so a GET response's EmailFiles array can be posted back here unchanged.

files

difficulty

string

enum

Difficulty level. Matches the console model and getPhishingEmail's Difficulty response field.

Allowed:

website

string

Phishing website template name.

profile

string

Sender profile (Email Sender ID) name.

geolocation

string

"Global" or a region code.

payloadType

string

enum

Allowed:

200Created

400Error