Add or update a 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 approved and monitored immediately;
  • rejected - NOTHING is saved and the call returns 409 with ErrorCode KEYWORD_NEEDS_CONFIRMATION and the reviewer's reason in Error. Relay that reason to a person and let them decide; do not blindly retry. To keep the keyword anyway, resend the same request with acceptWarning: true - it is then saved as pending_review and queued for manual review;
  • the reviewer was unavailable - the keyword is saved as pending_review and 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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
enum
required

domain for a domain the tenant owns; keyword for an additional brand term.

Allowed:
string
required

The domain (acme.com) or keyword (acmecorp). Normalised server-side. Keywords must be at least 4 characters - shorter terms match too much to be useful.

string

Optional human label, shown in alerts.

string

Supply to update an existing identifier; omit to add a new one.

boolean

Defaults to true. Set false to pause matching without removing the identifier.

boolean

Defaults to false. Send true only after a person has seen a KEYWORD_NEEDS_CONFIRMATION reason and still wants the keyword; it is then queued for manual review and is not monitored until approved. A non-boolean value is treated as false.

Responses

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