Skip to main content
Documentation

Jobs

jobs.set_stage

Move a job to another stage on the workflow board
WritesReaches the customerSensitiveWrite budget

REST

Shipping
POST /api/v1/jobs/set_stage

MCP tool

Live
jobs.set_stage

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

Operating contract

Moves one job to stage. This is the single most-automated thing a shop wants from an integration — 'when the tech marks it done in our other tool, move the job'.

IT CAN REACH THE CUSTOMER. A stage move fires the shop's own automations, and most shops hang a text off at least one stage ('your car is ready'). Nothing here decides that; the shop already did. Treat this as a customer-facing action.

ALREADY THERE IS A NO-OP: moving a job to the stage it is already at returns it unchanged and logs nothing, so a retrying integration cannot fire the same automation twice.

THE CLOCK IS NOT THE BOARD. Reaching in_progress or beyond stamps actual_start the FIRST time only — a move backwards never un-stamps it, because the original start is the truthful one. Entering completed re-stamps actual_end, and leaving it clears it, so an accidental complete → undo → real complete reports the real finish time.

Call jobs.stages for the stage keys.

Who may call it

Permission
jobs.accessThe caller must hold Jobs 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
job_idrequiredstringuuid

The job to move, as returned by jobs.list or jobs.get.

stagerequiredstring

The stage to move it to. Call jobs.stages for the list.

One of: lead, scheduled, in_progress, curing, qa, ready, completed, canceled

Output

FieldTypeDescription
idstring

numbernumber

titlestring | null

customer_idstring

vehicle_idstring | null

stagestring

assignee_idstring | null

scheduled_startstring | null

scheduled_endstring | null

actual_startstring | null

actual_endstring | null

location_addressstring | null

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/jobs/set_stage \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","stage":"lead"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/jobs/set_stage", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "stage": "lead"
  }),
});

// 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/jobs/set_stage",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "stage": "lead"
},
    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": "jobs.set_stage",
    "arguments": {
      "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "stage": "lead"
    }
  }
}

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 jobs.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.