On this page
PATCH/campaigns/:campaignId/leads/:leadId
Purpose
Set inbox tag, excluded, and/or CRM/profile fields (same allowlist as the product lead editor). Provide at least one field. Empty string or null clears a CRM value. LinkedIn URL cannot be changed.
Request
PATCH /campaigns/search_abc/leads/lead_xyz
X-API-Key: sk_live_...
Content-Type: application/json
{
"tag": "Interested",
"excluded": false,
"custom1": "Spoke at Web Summit"
}
| Field | Notes |
|---|---|
tag | Exact label below, or null / "" to clear |
excluded | boolean |
| CRM/profile | Optional strings: fullName, firstName, lastName, email, jobTitle, companyName, companyLinkedin, phone, website, companySize, companyCountry, companyCity, headline, location, personalization, custom, custom1–custom10 |
Allowed tags
Built-in labels (exact case):
Meeting requestInterestedInformation requestNot interestedWrong personTo be defined
An active workspace custom label is also accepted (matched without case sensitivity; the stored label is what gets saved). Custom labels are labels only. Unknown labels, archived custom labels, and wrong-case built-ins return 400.
{
"id": "lead_xyz",
"tag": "Interested",
"excluded": false,
"fields": { "custom1": "Spoke at Web Summit" }
}
May emit webhook lead.tagged. Unknown tag → 400 validation_error.
For many leads, prefer batch-update (immediate exclude; no polite-ack defer).
MCP
Tool: update_lead.