Skip to main content
POST
Add competitors

Authorizations

Authorization
string
header
required

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

Body

application/json
competitors
(string | object)[]
required

Competitors to add: a name (a domain is fine), or { name, domain?, aliases? }. Sending one already on the list with a domain or aliases updates them.

Required array length: 1 - 50 elements
Required string length: 1 - 200
Example:

Response

The list after the add.

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.