Set Owner Field Mappings

PUT

crm

owner-field-mappings

curl -X PUT "https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/owner-field-mappings",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ company_cs: { field: "customer_success_manager", direction: "crm_owns" } }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "company": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "contact": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "company_cs": { "field": "customer_success_manager", "direction": "crm_owns", "isDefault": false, "defaultField": "" },
    "resync": "triggered"
  }
}

{
  "success": false,
  "error": {
    "message": "Only workspace admins can change CRM settings",
    "code": "ADMIN_REQUIRED"
  }
}

Sets which property of one connected CRM holds each owner, and which side may change it. Send only the owners you want to change; an owner you leave out keeps what is saved. Admin only.

company: the account owner. Attack competitor alerts mention it.
contact: a connector’s owner.
company_cs: the CS owner of a company. Defense competitor alerts mention it. It has no default field on any CRM, and it is only ever read from the CRM.

Every field is checked against the CRM’s live schema: it must exist, and it must hold a CRM user (unless allowAnyField). For company and contact, it must also be writable when the direction lets Clustr write to it. A changed field starts a sync, so owners reflect the new field without waiting for the nightly one (resync in the response). Competitor alerts read the mapped fields live from the CRM when they are sent, so they use a new field straight away.

CS owner from an associated object

On HubSpot, the CS owner can live on another record than the company: a custom object associated with it, such as a “communities” object. Set object on company_cs to that object’s type, and field to its owner property (hubspot_owner_id when you leave it empty). When a company has several associated records with an owner, the oldest record’s owner is used. Clustr reads this owner on every sync and never writes it, so the direction is saved as crm_owns.

{"company_cs": {"object": "p_communities", "field": "hubspot_owner_id"}}

Reading a custom object needs the HubSpot connection to include the custom object scopes.

Errors

Status	Code	When
400		A field is not on the CRM, does not hold a user, is read-only for a direction that writes, or a direction is invalid. Also when `object` is sent for another owner than `company_cs` or another CRM than HubSpot
403	`ADMIN_REQUIRED`	The caller is not a workspace admin
404	`CRM_NOT_CONNECTED`	That CRM is not connected for this workspace

curl -X PUT "https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/owner-field-mappings",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ company_cs: { field: "customer_success_manager", direction: "crm_owns" } }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "company": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "contact": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "company_cs": { "field": "customer_success_manager", "direction": "crm_owns", "isDefault": false, "defaultField": "" },
    "resync": "triggered"
  }
}

{
  "success": false,
  "error": {
    "message": "Only workspace admins can change CRM settings",
    "code": "ADMIN_REQUIRED"
  }
}

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

company

object

The account owner, on a CRM company.

Show child attributes

contact

object

A connector's owner, on a CRM contact.

Show child attributes

company_cs

object

The CS owner, on a CRM company. It is always read from your CRM, so its direction is crm_owns or off: both and an omitted direction are saved as crm_owns, and clustr_owns answers 400. Send field: "" to unmap it.

Show child attributes

allowAnyField

boolean

default:false

Accept a field that holds something other than a CRM user. The field must still exist on the CRM.

Example:

false

Response

The saved owner field mappings

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl -X PUT "https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/crm/owner-field-mappings",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
    json={"company_cs": {"field": "customer_success_manager", "direction": "crm_owns"}},
)

await fetch("https://api.clustr-ai.com/api/public/crm/owner-field-mappings?provider=hubspot", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ company_cs: { field: "customer_success_manager", direction: "crm_owns" } }),
});

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "company": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "contact": { "field": "hubspot_owner_id", "direction": "both", "isDefault": true, "defaultField": "hubspot_owner_id" },
    "company_cs": { "field": "customer_success_manager", "direction": "crm_owns", "isDefault": false, "defaultField": "" },
    "resync": "triggered"
  }
}

{
  "success": false,
  "error": {
    "message": "Only workspace admins can change CRM settings",
    "code": "ADMIN_REQUIRED"
  }
}

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 Owner Field Mappings

CS owner from an associated object

Errors

Authorizations

Query Parameters

Body

Response

​CS owner from an associated object

​Errors

Authorizations

Query Parameters

Body

Response

CS owner from an associated object

Errors