Documentation
Jobs
jobs.set_stage
REST
ShippingPOST /api/v1/jobs/set_stageMCP tool
Livejobs.set_stageExposed 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
| Field | Type | Description |
|---|---|---|
| job_idrequired | stringuuid | The job to move, as returned by jobs.list or jobs.get. |
| stagerequired | string | The stage to move it to. Call jobs.stages for the list. One of:lead, scheduled, in_progress, curing, qa, ready, completed, canceled |
Output
| Field | Type | Description |
|---|---|---|
| id | string | — |
| number | number | — |
| title | string | null | — |
| customer_id | string | — |
| vehicle_id | string | null | — |
| stage | string | — |
| assignee_id | string | null | — |
| scheduled_start | string | null | — |
| scheduled_end | string | null | — |
| actual_start | string | null | — |
| actual_end | string | null | — |
| location_address | string | null | — |
| created_at | string | — |
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/jobs/set_stage \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","stage":"lead"}'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;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"]{
"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.
| 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 jobs.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. |