Competitors
Edit a competitor's name, website and variations.
apiKey writex-api-key<token>Workspace API key from Settings > API keys. Also accepted as Authorization: Bearer gsk_...
Scope: write
brandId*stringuuidcompetitorId*stringuuidapplication/jsonname*string1 <= length <= 255website*string1 <= length <= 2048aliases?array<>Other names or spellings for the competitor
items <= 10[]domainAliases?array<>Other domains the competitor uses
items <= 10[]includeSubdomains?booleanCount every subdomain of its domains as the competitor
falsetagIds?array<>Competitor tags to set; leave out to keep the current tags
items <= 50Competitor saved; a new domain refreshes its logo in the background
application/jsonid*stringuuidname*stringwebsite*stringdomain*stringlogoUrl*string|nullaliases*array<string>domainAliases*array<string>includeSubdomains*booleanrelation*CompetitorRelationdirect: tracked competitor; ignored: hidden and left out of analytics; suggested: found in AI answers, not reviewed yet
"direct""ignored""suggested"source*string"ai""user""response"tags*array<>curl -X PATCH 'https://app.gensiv.com/api/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/competitors/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "website": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "website": "string", "domain": "string", "logoUrl": "string", "aliases": [ "string" ], "domainAliases": [ "string" ], "includeSubdomains": true, "relation": "direct", "source": "ai", "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ]}curl -X PATCH 'https://app.gensiv.com/api/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/competitors/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"website": "string"
}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"website": "string",
"domain": "string",
"logoUrl": "string",
"aliases": [
"string"
],
"domainAliases": [
"string"
],
"includeSubdomains": true,
"relation": "direct",
"source": "ai",
"tags": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}