API Reference
Log In
API Reference

Send a test phishing email

post
https://api.caniphish.com/api/v3/campaigns/send-test-email

Sends a one-off test of a phishing email (to the nominated address) before launching a campaign, so you can verify rendering, links and the landing page. Uses the same test-send flow as the console.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
required

The recipient of the test email.

targetUsers
array of strings

Optional employee name(s)/identifier(s) threaded into the in-memory test campaign's target list. A test send always delivers to the single testEmail address regardless of what is supplied here; this has no effect on delivery and its only observable impact is on any personalization placeholders (e.g. recipient name) rendered into the test email.

targetUsers
phishingProfiles
array of objects
phishingProfiles
string
string
string
string
Responses

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago