API Reference
Log In
API Reference

Update reported-email settings (general & notifications)

post
https://api.caniphish.com/api/v3/settings/phish-reporting/update-phish-reporting

The General and Notifications settings for employee email reporting: whether reporting is enabled, administrator notifications, reporter notifications, and how reported emails are forwarded. Any field you omit is left unchanged.

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

Allow employees to report suspected phishing/spam emails (the master on/off toggle).

adminNotifications
object

Notify administrators when a reported email requires analysis.

reporterNotifications
object

Notify the employee who reported an email when it is given one of these attributions (true = notify them). The notification wording is configured under Notification settings.

string
enum

How reported emails are delivered to your reporting inbox. "auto" lets CanIPhish choose the best format; "inline" forwards the message inline; "attachment" forwards it as an attachment; "smtp" forwards it directly over SMTP.

Allowed:
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