Documentation
Leads
leads.set_status
REST
ShippingPOST /api/v1/leads/set_statusMCP tool
Liveleads.set_statusExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Leads domain.
Operating contract
Its OWN capability rather than a parameter of leads.update, because the consequence is different: a status change writes lead.status_changed to the timeline, and a shop's automations can be wired to that event — which means this call can end in the customer getting a text.
status must be one of the values leads.statuses returns. Moving a lead to the status it is already in succeeds and changes nothing.
lost_reason is only recorded when status is lost, and it should be the shop's own words about why — it is what the lost-reason report counts.
Moving to contacted, qualified or quoted stamps 'last contacted' as now, because those are the statuses a person sets after they have actually reached somebody. Do not use them to record an attempt that failed.
Moving to won or lost clears the follow-up reminder.
Refuses with 'this lead just changed elsewhere' when the status moved between your read and this write — which usually means the shop's own SMS rail advanced it. Re-read with leads.get before deciding again; do not retry blindly.
Who may call it
- Permission
leads.accessThe caller must hold Leads at the ACT level. A read-only dashboard grant on the same section is refused.- Plan
- Every planNo plan gate. Available on every Service VIN plan.
- Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.- Rate class
writeCounted against the write budget, which is tighter than a read.
Input
| Field | Type | Description |
|---|---|---|
| lead_idrequired | stringuuid | The lead to move, as returned by leads.list or leads.get. |
| statusrequired | string | The status to move it to, as listed by leads.statuses. One of:new, contacted, qualified, quoted, won, lost, cold |
| lost_reason | stringmax 500 chars | Why it was lost, in the shop's own words. Only used when status is lost. |
Output
| Field | Type | Description |
|---|---|---|
| lead_id | string | — |
| status | string | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/leads/set_status \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"lead_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","status":"new"}'const res = await fetch("https://www.servicevin.com/api/v1/leads/set_status", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"status": "new"
}),
});
// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/leads/set_status",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"status": "new"
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "leads.set_status",
"arguments": {
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"status": "new"
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold leads.access. |
| 403 | insufficient_scope | The credential is read-only and this capability writes. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many write calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |