Skip to main content
Documentation

Leads

leads.add_note

Put a note on one lead's timeline
WritesWrite budget

REST

Shipping
POST /api/v1/leads/add_note

MCP tool

Live
leads.add_note

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

Operating contract

Appends a note to the lead's activity trail, where it sits alongside the status moves, the assignments and the messages so somebody picking this lead up in three weeks can see what happened.

APPEND-ONLY. A note cannot be edited or removed once written, by anybody, which is what makes the trail worth reading. Write what you would be happy for the shop's owner to read back — and do not put a customer's card details, a password or anything else you would not write on a job card in it.

Write what was said and what was agreed, not a summary of your own reasoning. 'Called, no answer, will try Thursday' is useful; 'following up' is not.

Returns nothing but a confirmation. Read the trail back with the lead's own screen, or call leads.get for the record's current state.

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
noneA repeat genuinely does it twice and no key can make it not. Read before you write; the operating contract says what to read.
Rate class
writeCounted against the write budget, which is tighter than a read.

Input

FieldTypeDescription
lead_idrequiredstringuuid

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

noterequiredstringmax 2000 chars, min 1 chars

The note. Plain text, up to 2000 characters.

Output

FieldTypeDescription
lead_idstring

recordedboolean

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/add_note \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lead_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","note":"Left a voicemail about Friday."}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/leads/add_note", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "note": "Left a voicemail about Friday."
  }),
});

// 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/add_note",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "note": "Left a voicemail about Friday."
},
    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.add_note",
    "arguments": {
      "lead_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "note": "Left a voicemail about Friday."
    }
  }
}

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.