Skip to main content
Documentation

Jobs

jobs.schedule

Rebook a job to a new start and end time
WritesReaches the customerSensitiveWrite budget

REST

Shipping
POST /api/v1/jobs/schedule

MCP tool

Live
jobs.schedule

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

Operating contract

Moves when the job is booked. Both scheduled_start and scheduled_end are required together — a booking with only one end is not a slot anybody can plan around — and the end must be after the start.

TIMES ARE ISO 8601 WITH AN OFFSET, e.g. '2026-09-08T09:00:00-06:00'. Send the shop's local time with its offset; if you do not know the shop's timezone, ask rather than assuming yours.

IT CAN REACH THE CUSTOMER. A reschedule fires the shop's automations, and a rebooked-confirmation text is one of the commonest ones a shop turns on.

THIS DOES NOT CHECK CAPACITY. It moves the booking; it does not ask whether a bay or an installer is free. Read jobs.list for the day first if that matters.

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 rebook, as returned by jobs.list or jobs.get.

scheduled_startrequiredstringdate-time

New start, ISO 8601 with an offset, in the shop's local time.

scheduled_endrequiredstringdate-time

New end, ISO 8601 with an offset. Must be after scheduled_start.

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/schedule \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","scheduled_start":"2026-09-05T14:20:00.000Z","scheduled_end":"2026-09-05T14:20:00.000Z"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/jobs/schedule", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "scheduled_start": "2026-09-05T14:20:00.000Z",
    "scheduled_end": "2026-09-05T14:20:00.000Z"
  }),
});

// 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/schedule",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "scheduled_start": "2026-09-05T14:20:00.000Z",
    "scheduled_end": "2026-09-05T14:20:00.000Z"
},
    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.schedule",
    "arguments": {
      "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "scheduled_start": "2026-09-05T14:20:00.000Z",
      "scheduled_end": "2026-09-05T14:20:00.000Z"
    }
  }
}

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.