Documentation
Jobs
jobs.set_notes
REST
ShippingPOST /api/v1/jobs/set_notesMCP tool
Livejobs.set_notesExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Jobs domain.
Operating contract
Sets the job's note field — the shop's own working notes about this car. INTERNAL: the customer never sees it.
IT REPLACES, IT DOES NOT APPEND. Read jobs.get first if you mean to add to what is already there, or you will overwrite somebody's note. Send an empty string to clear it.
Because it replaces rather than appends, running the same call twice leaves exactly the same note — no idempotency key needed.
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 note, as returned by jobs.list or jobs.get. |
| notesrequired | stringmax 8000 chars | The complete new note text. Replaces what is there. Empty clears it. |
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_notes \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"job_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","notes":"Left a voicemail about Friday."}'const res = await fetch("https://www.servicevin.com/api/v1/jobs/set_notes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"notes": "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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/jobs/set_notes",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"notes": "Left a voicemail about Friday."
},
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_notes",
"arguments": {
"job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
"notes": "Left a voicemail about Friday."
}
}
}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. |