Skip to main content
PATCH
Set a competitor's domain or other names

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

name
string
required
Required string length: 1 - 200
Example:

"Athena"

Body

application/json
domain
string | null

Its website, a bare host such as athenahq.ai. null removes one set here (a domain setup found stays).

Maximum string length: 253
Example:

"athenahq.ai"

aliases
string[]

Other names AI answers use for it, up to 8, each 2 to 80 characters. Replaces the stored ones.

Maximum array length: 20
Maximum string length: 200
Example:

Response

The list and roster after the update.

changed
string[]
required

The names this request added, removed or updated; empty when nothing changed.

competitors
string[]
required

The competitor list after the request.

pinned
boolean
required

True when the request changed and pinned the list, so automated discovery keeps it.

roster
object[]
required

How the next scan matches each competitor. Stored answers are not rewritten.