Skip to main content
PATCH
Change a source classification rule

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

ruleId
string
required

A source classification rule's id (id from GET .../sources/rules).

Required string length: 1 - 128

Body

application/json
citationType
enum<string>
required

A Source Type. brand is the app's Owned.

Available options:
brand,
competitor,
editorial,
social,
forum,
review,
institutional,
third_party,
other
competitorId
string | null

Required for a competitor rule; ignored for any other type.

Maximum string length: 64

Response

The rule was changed.

A saved rule change.

rule
object | null
required

The rule created or changed; null for a removal.

removed
integer
required

Rules a removal deleted.

impact
object
required

What a rule change does to the citations already stored.

status
object
required
success
boolean
required

Always true — injected on every success response by this endpoint family's response wrapper.