Skip to main content
Documentation

Vehicles

vehicles.update

Change one detail on a vehicle
WritesWrite budget

REST

Shipping
POST /api/v1/vehicles/update

MCP tool

Live
vehicles.update

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

Operating contract

PERFORMS EXACTLY ONE CHANGE PER CALL, selected by which parameter you provide: mileage, color, license_plate, trim or vehicle_type. To make several changes, call this once per change.

Sending two at once is refused rather than guessed at.

THE VIN IS NOT CHANGEABLE HERE, on purpose. A VIN is the car's identity, and 'this row is a different car now' is not an edit — it is a new vehicle in the garage and, usually, a mistake somebody wants to find later.

vehicle_type drives tiered pricing, so changing it changes what this car is quoted. Call vehicles.types for the list.

Who may call it

Permission
customers.accessThe caller must hold Customers 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
vehicle_idrequiredstringuuid

The vehicle to change, as returned by vehicles.list or vehicles.get.

mileageinteger0–2000000

A new odometer reading.

colorstringmax 40 chars

A new colour.

license_platestringmax 20 chars

A new licence plate.

trimstringmax 60 chars

A new trim.

vehicle_typestring

A new size class for tiered pricing. Call vehicles.types for the list.

One of: car, truck, suv, van, coupe, motorcycle, commercial, exotic

Output

FieldTypeDescription
idstring

customer_idstring

labelstring | null

yearnumber | null

makestring | null

modelstring | null

trimstring | null

colorstring | null

vinstring | null

license_platestring | null

mileagenumber | null

vehicle_typestring

created_atstring

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/vehicles/update \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/vehicles/update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "vehicle_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/vehicles/update",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "vehicle_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": "vehicles.update",
    "arguments": {
      "vehicle_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 customers.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.