Skip to main content
Documentation

Customers

customers.add_note

Add an internal note to a customer record
WritesWrite budget

REST

Shipping
POST /api/v1/customers/add_note

MCP tool

Live
customers.add_note

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

Operating contract

Appends one note to the customer's record. INTERNAL — the customer never sees it, and nothing about this reaches them.

APPENDING IS NOT IDEMPOTENT BY ITSELF: calling this twice leaves two notes. Pass a stable idempotency key from your own system (an event id, a message id) and a retry after a timeout will not double the note. A freshly generated key each call buys nothing.

pinned keeps the note at the top of the customer's record for everyone in the shop.

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
keyHonours an Idempotency-Key header. Pass a stable one and a retry replays the first answer instead of acting again.
Rate class
writeCounted against the write budget, which is tighter than a read.

Input

FieldTypeDescription
customer_idrequiredstringuuid

The customer to note, as returned by customers.list or customers.get.

bodyrequiredstringmax 4000 chars, min 1 chars

The note text.

pinnedboolean

Keep this note at the top of the customer's record.

Default: false

Output

FieldTypeDescription
idstring

bodystring

is_pinnedboolean

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/customers/add_note \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","body":"Left a voicemail about Friday.","pinned":false}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/customers/add_note", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "body": "Left a voicemail about Friday.",
    "pinned": false
  }),
});

// 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/customers/add_note",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "body": "Left a voicemail about Friday.",
    "pinned": False
},
    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": "customers.add_note",
    "arguments": {
      "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "body": "Left a voicemail about Friday.",
      "pinned": false
    }
  }
}

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.