Set An Opportunity's Tags

PUT

record-tags

path

curl -X PUT "https://api.clustr-ai.com/api/public/record-tags/path?client_linkedin_id=nicdelaye&prospect_linkedin_id=jane-smith" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_ids": ["8f652e61-edfa-4a8c-8763-cc4902dd386b"], "mode": "add"}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/record-tags/path",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"client_linkedin_id": "nicdelaye", "prospect_linkedin_id": "jane-smith"},
    json={"tag_ids": [contacted_tag_id], "mode": "add"},
)

{
  "success": true,
  "data": {
    "tags": [
      {
        "id": "8f652e61-edfa-4a8c-8763-cc4902dd386b",
        "group_id": "2b7c9d10-4e5f-4a61-9c22-8d3f1a7b0e44",
        "name": "Contacted",
        "color": "#3B82F6"
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "client_linkedin_id and prospect_linkedin_id are required", "code": "BAD_REQUEST" }
}

The write that replaces setting a status. Add the tag you want from the path group named Status: the group is single, so the tag already there is swapped out. The response is the path’s tags read back after the write.

Query Parameters

string

required

The connector’s LinkedIn public identifier.

string

required

The prospect’s LinkedIn public identifier.

Body

string[]

required

Tag ids from a group whose subject_type is path, from List Tag Groups.

string

default:"replace"

replace, add or remove. A bare replace is the path’s whole set, so send group_id when you mean one group.

string

Narrows a replace to one group.

The old way still works, for now. status_id on Update Opportunity takes a path tag id and writes the same assignment. It is deprecated; this endpoint is the one to build against.

curl -X PUT "https://api.clustr-ai.com/api/public/record-tags/path?client_linkedin_id=nicdelaye&prospect_linkedin_id=jane-smith" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_ids": ["8f652e61-edfa-4a8c-8763-cc4902dd386b"], "mode": "add"}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/record-tags/path",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"client_linkedin_id": "nicdelaye", "prospect_linkedin_id": "jane-smith"},
    json={"tag_ids": [contacted_tag_id], "mode": "add"},
)

{
  "success": true,
  "data": {
    "tags": [
      {
        "id": "8f652e61-edfa-4a8c-8763-cc4902dd386b",
        "group_id": "2b7c9d10-4e5f-4a61-9c22-8d3f1a7b0e44",
        "name": "Contacted",
        "color": "#3B82F6"
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "client_linkedin_id and prospect_linkedin_id are required", "code": "BAD_REQUEST" }
}

curl -X PUT "https://api.clustr-ai.com/api/public/record-tags/path?client_linkedin_id=nicdelaye&prospect_linkedin_id=jane-smith" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_ids": ["8f652e61-edfa-4a8c-8763-cc4902dd386b"], "mode": "add"}'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/record-tags/path",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"client_linkedin_id": "nicdelaye", "prospect_linkedin_id": "jane-smith"},
    json={"tag_ids": [contacted_tag_id], "mode": "add"},
)

{
  "success": true,
  "data": {
    "tags": [
      {
        "id": "8f652e61-edfa-4a8c-8763-cc4902dd386b",
        "group_id": "2b7c9d10-4e5f-4a61-9c22-8d3f1a7b0e44",
        "name": "Contacted",
        "color": "#3B82F6"
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "client_linkedin_id and prospect_linkedin_id are required", "code": "BAD_REQUEST" }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Record Activity

Lists

Tags

Account Tags

Target Accounts

Client Companies

ICP

Competitor Monitoring

Connector Refresh

Notifications

Set An Opportunity's Tags

Query Parameters

Body

​Query Parameters

​Body

Query Parameters

Body