LLllmpulse
Competitors

Update a competitor

Updates brand_name, the competitor website domain or host, matching_names (full replacement list; the brand name is always included automatically), color and/or the citation URL matching rule. Website domain/host and citation-rule changes share one seven-day cooldown per competitor; other fields remain editable during the cooldown. Name, website or citation-rule changes re-run historical matching in the background: the competitor shows processing=true for a few minutes and further edits are rejected meanwhile. Requires a read_write scope API key.

patch/competitors/{id}

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • URL
    https://api.llmpulse.ai/api/v1/competitors/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

project_idinteger required
brand_namestring
domainstring

Website domain or host used for citation matching. A full URL is accepted and normalised to its host.

matching_namesstring[]

FULL replacement list of the names this competitor is matched by; brand_name is added automatically. At most 50 names in all, brand_name included, of up to 100 characters each; a longer list or name is refused with ERR_INVALID_PARAM (422) and nothing in the request is applied

colorstring

Hex color, e.g. #1a2b3c

citation_match_mode'domain' | 'host' | 'path_prefix'
citation_match_pathstring

Required when changing citation_match_mode to path_prefix

Response

Updated

Changes

No recorded changes to this operation across all 32 revisions of this API.