Create a phishing website template

post

https://api.caniphish.com/api/v3/content-library/phishing-websites/create-phishing-website

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

tenantID

string

required

templateName

string

required

templateDescription

string

websiteUrl

string

When managedDomain is true, this is the base CanIPhish-managed domain only (e.g. "https://authwebmail.com") — the hosted page is selected separately via webPage, and the two are composed server-side into the stored websiteURL ("/"). When managedDomain is false (Customer Managed / BYO), this is the full absolute URL of the page to clone and is stored as-is. get/listPhishingWebsites return the managed base domain and webPage id as separate fields (websiteDomain/webPage) so a GET response can be fed straight back into this field pair.

screenshot

string

Thumbnail image URL.

subDomain

string

Defaults to auth

Managed-domain subdomain label (single alphanumeric/hyphen label). Defaults to "auth" when omitted.

managedDomain

boolean

Defaults to true

True for a CanIPhish-managed domain (websiteUrl + webPage composed together), false for a Customer Managed / BYO absolute URL in websiteUrl. The console's create wizard defaults this option to checked (true) — omitting this field here also defaults to true. If true is combined with a websiteUrl that isn't a recognized CanIPhish-managed domain, it is silently downgraded to false and websiteUrl is stored as-is (Customer Managed) rather than rejected.

webPage

string

Opaque id of the CanIPhish-hosted page to present (only used when managedDomain is true), e.g. "2" for Google, "5" for PayPal. See getReferenceData for the id -> display-name mapping.

customHtml

string

Optional custom HTML (sanitized server-side). When set on a managedDomain template, it permanently replaces the webPage segment in the stored websiteURL with a "cp-" marker — the original webPage id can no longer be recovered from a subsequent GET.

Responses

Language

Credentials

Loading…

Response

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

application/json

200Created

400Error