Skip to main content
PUT
Create or update a tracked GEO competitor

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Body

application/json
name
string
required
Required string length: 1 - 128
domain
string | null
required
Maximum string length: 128
previousName
string

Set to rename an existing competitor.

Required string length: 1 - 128
synonyms
string[]
Maximum array length: 8
Required string length: 1 - 128
kind
enum<string>

Label only; it does not change how mentions are counted. Omit to keep the current kind, or direct for a new competitor.

Available options:
direct,
indirect
color
string | null
Maximum string length: 128

Response

Competitor saved successfully

competitors
object[]
required

Tracked competitors, oldest first.

organization
object
required