Skip to main content
Documentation

Leads

leads.assign

Give one lead to a teammate, or take its owner off
WritesWrite budget

REST

Shipping
POST /api/v1/leads/assign

MCP tool

Live
leads.assign

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Leads domain.

Operating contract

PERFORMS EXACTLY ONE CHANGE PER CALL, selected by which parameter you provide: assignee hands the lead to that teammate, unassign: true takes the owner off and leaves it in the unclaimed pile. Sending both is refused.

assignee is a login's user id from leads.assignees and nothing else. It is NOT the staff_id that jobs.assign takes — a shop can have bench staff with no login, and handing a lead to one of them puts it somewhere nobody can see it. If the id is not on the roster this refuses rather than writing it.

A manual assignment OVERWRITES an existing owner. That is deliberate — this is somebody saying 'this one is mine now' — so read the lead first if you are not sure it is unclaimed.

The new owner is notified; the person doing the assigning never is. Nothing reaches the customer.

Assigning a lead to whoever already owns it succeeds and rings nobody.

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

FieldTypeDescription
lead_idrequiredstringuuid

The lead to hand over, as returned by leads.list or leads.get.

assigneestringuuid

The teammate's user id, as returned by leads.assignees.

unassignboolean

True takes the current owner off and leaves the lead unclaimed.

Output

FieldTypeDescription
lead_idstring

assigneestring | null

changedboolean

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/leads/assign \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lead_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/leads/assign", {
  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;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/leads/assign",
    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"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "leads.assign",
    "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.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold leads.access.
403insufficient_scopeThe credential is read-only and this capability writes.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many write calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.