Set Tag Field CRM Mappings

PUT

crm

tag-group-mappings

curl -X PUT "https://api.clustr-ai.com/api/public/crm/tag-group-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mappings": [{"group_id": "GROUP_ID", "object_type": "companies", "property": "clustr_audience", "direction": "clustr_owns", "options": {"TAG_ID": "Competitor customer"}}]}'

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "mappings": [
      {
        "group_id": "5b0c2e7a-3f41-4d8e-9a6b-1c2d3e4f5a6b",
        "object_type": "companies",
        "property": "clustr_audience",
        "shape": "multiselect",
        "direction": "clustr_owns",
        "options": {
          "9f8e7d6c-5b4a-4321-8fed-cba987654321": "Competitor customer"
        }
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "message": "direction must be clustr_owns, fill_if_empty, crm_owns or off",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

Replaces one CRM’s tag field mappings with the list you send. Read them first with Get Tag Field CRM Mappings, change what you need and send the whole list back. An empty list stops every tag sync to that CRM. Admin keys only.

curl -X PUT "https://api.clustr-ai.com/api/public/crm/tag-group-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mappings": [{"group_id": "GROUP_ID", "object_type": "companies", "property": "clustr_audience", "direction": "clustr_owns", "options": {"TAG_ID": "Competitor customer"}}]}'

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

confirm

boolean

Letting the CRM own a tag field it did not own before (crm_owns) replaces Clustr's tags in that field with the CRM's values on every synced record, so such a save writes nothing and answers confirmationRequired: true with crmOwnedGroupIds and a message. Send the same request with confirm set to true to apply it.

mappings

object[]

Every mapping this CRM should have, in full. A mapping without a group_id is dropped.

Show child attributes

Response

The saved tag field mappings

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl -X PUT "https://api.clustr-ai.com/api/public/crm/tag-group-mappings?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mappings": [{"group_id": "GROUP_ID", "object_type": "companies", "property": "clustr_audience", "direction": "clustr_owns", "options": {"TAG_ID": "Competitor customer"}}]}'

{
  "success": true,
  "data": {
    "provider": "hubspot",
    "mappings": [
      {
        "group_id": "5b0c2e7a-3f41-4d8e-9a6b-1c2d3e4f5a6b",
        "object_type": "companies",
        "property": "clustr_audience",
        "shape": "multiselect",
        "direction": "clustr_owns",
        "options": {
          "9f8e7d6c-5b4a-4321-8fed-cba987654321": "Competitor customer"
        }
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "message": "direction must be clustr_owns, fill_if_empty, crm_owns or off",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

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 Tag Field CRM Mappings

Authorizations

Query Parameters

Body

Response