Skip to main content
PATCH
Update a competitor’s details. Send only the fields you want to change. A competitor is monitored until you delete it.

Authorizations

​
Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Path Parameters

​
id
string
required

The competitor's Clustr ID (cmp_…), from List Competitors. The id from earlier responses also works.

Body

application/json
​
company_name
string
​
domain
string
​
linkedin_url
string
​
website_url
string

The marketing website Clustr reads to find the competitor's customers. The new site is read on the next run. An empty string resets it to https://<domain>. When you change only the domain, a website that was the old domain's default follows it.

​
title_groups
enum<string>[]

The roles to follow at the competitor. An empty list goes back to the job titles that are on in your settings. The next team check searches them.

Available options:
sales,
cs,
exec,
founder,
customer_facing,
custom

Response

Updated competitor

​
success
boolean
required
Example:

true

​
data
object
required

A competitor monitored for your workspace.