Documentation
Leads
leads.convert_to_customer
REST
ShippingPOST /api/v1/leads/convert_to_customerMCP tool
Liveleads.convert_to_customerExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Leads domain.
Operating contract
Files the lead as a proper customer: the person, and the car they enquired about in that customer's garage. This is the step between an enquiry and any real work — a quote, a job and an invoice all hang off a customer, not off a lead.
IDEMPOTENT AND SAFE TO CALL TWICE. A lead already linked to a customer returns that same customer rather than creating a second one, and the lead's own details are matched against the shop's existing customers first — so a returning caller lands back on the record that already holds their history rather than becoming a duplicate of themselves.
THE LEAD IS NOT CONSUMED. It stays exactly where it is, in whatever status it had, and keeps its notes and its source attribution. Converting is a link, not a move — mark the lead won with leads.set_status if that is what happened.
vehicle_id is the car from the enquiry, when the lead described one well enough to file. Null means it did not, and the vehicle is worth asking the customer about before quoting: vehicles.create files it against the customer this returns.
already_linked: true means the lead was already converted and nothing was written this time.
This returns the whole link, so nothing is truncated.
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 file as a customer, as returned by leads.list. |
Output
| Field | Type | Description |
|---|---|---|
| lead_id | string | — |
| customer_id | string | — |
| vehicle_id | string | null | — |
| already_linked | boolean | — |
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/convert_to_customer \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"lead_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/leads/convert_to_customer", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}),
});
// 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/convert_to_customer",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
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.convert_to_customer",
"arguments": {
"lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}
}
}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. |