Competitors

Edit a competitor

Changed on

Edit a tracked competitor as the in-app competitor sheet does: rename it, change its website domain, make it a direct or a SERP competitor, and add or remove the other names it goes by (name variations), which is how its mentions are recognised in AI answers. Changing the domain, or making it direct, re-matches its past mentions in the background. Everything is checked before anything is written: a variation that is another competitor's name is refused with 409 conflict (merge the two in the app instead), and removing a name the competitor does not have is refused with 400. A name confirmed as another competitor's variation moves to this one. A body with no fields changes nothing and answers with the competitor and its name variations. Requires the competitor:match capability and a manage-tier role, as in the app. A pitch project that is not currently active refuses with 409 INACTIVE_PITCH_PROMPT_MUTATION.

patch/api/mcp/projects/{projectId}/competitors/{competitorId}

Request

  • Base URL
    https://app.searchable.com
  • Auth
    HTTP bearer

Path parameters

projectIdstring uuid required

The project id.

competitorIdstring uuid required

The competitor's id.

Request body

namestring

The competitor's new name.

domainstring

Its website domain, e.g. example.com.

isDirectCompetitorboolean

true makes it a direct competitor, explicitly tracked; false makes it a SERP competitor, one that appears when AI results mention it.

addVariationsstring[]

Other names it goes by, to add.

removeVariationsstring[]

Name variations to remove. Each must be one it has.

Response

Competitor updated.

successboolean required
variationsstring[] required

Its name variations after the edit.

removedstring[] required

The variations removed.

Changes