post
https://api.caniphish.com/api/v3/brand-protection/save-brand-identifier
Adds a brand identifier, or updates an existing one by passing its identifierID. Monitoring starts as soon as the first identifier is added - there is no separate activation step. Requires an Enterprise subscription.
A domain must already be one of your verified domains: verify it under Employees first, otherwise this returns 400 with ErrorCode DOMAIN_NOT_VERIFIED.
A keyword is checked by an automated reviewer when it is first added and whenever its value changes (toggling active or editing label does not re-run the review, so an approved keyword keeps its approval). Three outcomes:
- accepted - saved with approvalStatus
approvedand monitored immediately; - rejected - NOTHING is saved and the call returns 409 with ErrorCode
KEYWORD_NEEDS_CONFIRMATIONand the reviewer's reason inError. Relay that reason to a person and let them decide; do not blindly retry. To keep the keyword anyway, resend the same request withacceptWarning: true- it is then saved aspending_reviewand queued for manual review; - the reviewer was unavailable - the keyword is saved as
pending_reviewand queued.
A pending_review identifier is stored but has isMonitoring false: it produces no findings until a person approves it.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…