SEsenso
Tracked Competitors

Update a tracked competitor

Replaces the competitor's name and URL. name is required; if url is omitted, the competitor's existing URL is cleared.

put/org/competitors/{competitorId}

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

competitorIdstring uuid required

The competitor's id.

Request body

namestring required

Competitor brand name.

urlstring uri

Competitor website URL. On update, omitting it keeps the current URL and an empty string clears it. Its host is always added to domains.

domainsstring[]

When present, replaces the domains this competitor's citations are attributed to (hosts such as acme.com; URLs are reduced to their host). Omit to leave them unchanged.

Response

The updated competitor.

idstring uuid required

Unique identifier of the tracked competitor.

brand_keystring

The normalized brand key analytics store this competitor under. Two names with the same key (for example "Acme" and "Acme Inc") are the same competitor.

domainsstring[] required

Domains whose citations count as this competitor's.

org_idstring uuid required

The organization that owns this entry.

namestring required

Competitor brand name.

urlstring

Competitor website URL, when set.

source'manual' | 'suggested_run_text' | 'suggested_web_search' required

How this entry was added — added by hand, or AI-suggested from run text or a web search.

rationalestring

For AI-suggested entries, why this competitor was proposed.

confidencenumber

For AI-suggested entries, the suggestion confidence (0–1).

created_atstring date-time required

When the entry was created.

updated_atstring date-time required

When the entry was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.