Set Competitor CRM Properties

PUT

crm

competitor-properties

curl -X PUT "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"properties": {"competitor_customer": {"enabled": true}, "competitor_confidence": {"enabled": true}}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"properties": {"competitor_customer": {"enabled": True}, "competitor_confidence": {"enabled": True}}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    properties: { competitor_customer: { enabled: true }, competitor_confidence: { enabled: true } },
  }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "properties": [
      { "key": "competitor_customer", "label": "Competitor customer", "enabled": true, "field": "", "defaultField": "clustr_competitor_customer", "effectiveField": "clustr_competitor_customer" },
      { "key": "competitor_confidence", "label": "Competitor customer confidence", "enabled": true, "field": "", "defaultField": "clustr_competitor_confidence", "effectiveField": "clustr_competitor_confidence" },
      { "key": "competitor_last_engagement", "label": "Last competitor engagement", "enabled": false, "field": "", "defaultField": "clustr_last_competitor_engagement", "effectiveField": "clustr_last_competitor_engagement" }
    ],
    "resync": "triggered"
  }
}

Turns competitor properties on or off for one connected CRM, and chooses the company field each one writes. Send only the properties you want to change: one you leave out keeps its saved setting. Admin only.

Key	What lands on the company
`competitor_customer`	The competitors the company is a customer of
`competitor_confidence`	`confirmed`, `likely` or `possible`
`competitor_last_engagement`	The date a competitor’s people last engaged someone at the company

On HubSpot, Clustr creates a company property for each one (clustr_competitor_customer, clustr_competitor_confidence and clustr_last_competitor_engagement) unless you name a field of your own. On Salesforce and Attio, create the field first and name it in field: Clustr does not create fields there. A field you name must exist on the CRM and be writable.

Values stay current. Turning a property on starts a CRM sync, and every sync after it rewrites the values. When you reject a customer, or a competitor takes it off their site, the next sync clears the field on that company. Companies Clustr never linked to a competitor are left alone.

Errors

Status	Code	When
400		An unknown property, or a property turned on with no field on Salesforce or Attio, or a field that does not exist or is read-only
403		The key’s workspace role is not admin
404	`CRM_NOT_CONNECTED`	That CRM is not connected for this workspace

curl -X PUT "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"properties": {"competitor_customer": {"enabled": true}, "competitor_confidence": {"enabled": true}}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"properties": {"competitor_customer": {"enabled": True}, "competitor_confidence": {"enabled": True}}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    properties: { competitor_customer: { enabled: true }, competitor_confidence: { enabled: true } },
  }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "properties": [
      { "key": "competitor_customer", "label": "Competitor customer", "enabled": true, "field": "", "defaultField": "clustr_competitor_customer", "effectiveField": "clustr_competitor_customer" },
      { "key": "competitor_confidence", "label": "Competitor customer confidence", "enabled": true, "field": "", "defaultField": "clustr_competitor_confidence", "effectiveField": "clustr_competitor_confidence" },
      { "key": "competitor_last_engagement", "label": "Last competitor engagement", "enabled": false, "field": "", "defaultField": "clustr_last_competitor_engagement", "effectiveField": "clustr_last_competitor_engagement" }
    ],
    "resync": "triggered"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

provider

enum<string>

required

The CRM to read or change: hubspot, salesforce or attio. That CRM must be connected to your workspace.

Available options:

hubspot,

salesforce,

attio

Body

application/json

properties

object

The property key (competitor_customer, competitor_confidence or competitor_last_engagement) to its new setting.

Show child attributes

Response

The saved competitor properties

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl -X PUT "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"properties": {"competitor_customer": {"enabled": true}, "competitor_confidence": {"enabled": true}}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"properties": {"competitor_customer": {"enabled": True}, "competitor_confidence": {"enabled": True}}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    properties: { competitor_customer: { enabled: true }, competitor_confidence: { enabled: true } },
  }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "properties": [
      { "key": "competitor_customer", "label": "Competitor customer", "enabled": true, "field": "", "defaultField": "clustr_competitor_customer", "effectiveField": "clustr_competitor_customer" },
      { "key": "competitor_confidence", "label": "Competitor customer confidence", "enabled": true, "field": "", "defaultField": "clustr_competitor_confidence", "effectiveField": "clustr_competitor_confidence" },
      { "key": "competitor_last_engagement", "label": "Last competitor engagement", "enabled": false, "field": "", "defaultField": "clustr_last_competitor_engagement", "effectiveField": "clustr_last_competitor_engagement" }
    ],
    "resync": "triggered"
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

Set Competitor CRM Properties

Errors

Authorizations

Query Parameters

Body

Response

​Errors

Authorizations

Query Parameters

Body

Response

Errors