API Reference
Log In
API Reference

Update reported-email quarantine settings

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

The Quarantine settings: which mailbox provider quarantines reported emails, which attributions trigger a quarantine, and whether actual spam/phish is reported to the provider. Connector credentials are set separately via Save quarantine connector credentials — they are not accepted here. 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
string
enum

Which mailbox provider quarantines eligible reported emails. "none" disables quarantine. Changing this marks the connection as not-connected until credentials are re-validated.

Allowed:
quarantineAttributions
object

Immediately quarantine reported emails given any of these attributions.

boolean

Report emails marked as actual spam/phishing to the email provider (Microsoft or Google) to help prevent similar emails reaching inboxes.

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