Remove tags from a lead

POST/leads/tags/remove

Removes tags from a lead and its conversations.

Try itSend a real request with your API key

API key Body JSON

This changes your workspace, as the same change in the app would. Your key stays in this page and goes only to Salesteam.

Headers

Idempotency-Keystring
Any unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.

Body

leadIdstring or null
linkedinUrlstring or null
tagsarray of stringRequired
Tag names, or one tag as a string. Up to 20.
emailstring · email or null
The lead’s email: the one Salesteam found or was sent. Handy when a calendar or CRM knows only the email. Up to 254 characters.

Answer

200 OK The lead’s tags now.

dataTagsResultRequired
Inside it
- leadIdstringRequired
- tagsarray of stringRequired

Errors

400 Bad requestinvalid_request invalid_json duplicate_in_request
401 Unauthorizedunauthorized
404 Not foundnot_found not_in_campaign
422 Can’t processidempotency_key_reused
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

POST /leads/tags/remove

curl -X POST "https://app.salesteam.dev/api/v1/leads/tags/remove" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "leadId": "lead_8f2c",
  "tags": [
    "Hot lead"
  ]
}'

const response = await fetch("https://app.salesteam.dev/api/v1/leads/tags/remove", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "leadId": "lead_8f2c",
    "tags": [
      "Hot lead"
    ]
  }),
});
console.log(response.status, await response.json());

import os, uuid
import requests

response = requests.post(
    "https://app.salesteam.dev/api/v1/leads/tags/remove",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
        "leadId": "lead_8f2c",
        "tags": [
            "Hot lead",
        ],
    },
)
print(response.status_code, response.json())

200 answer

{
  "data": {
    "leadId": "lead_7Qm2xT9a",
    "tags": [
      "tag"
    ]
  }
}