reviews.settings

Read how this shop asks for reviews and routes the unhappy ones

Read-onlyRead budget

REST

Shipping

POST /api/v1/reviews/settings

MCP tool

Live

reviews.settings

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

Operating contract

HOW THE ASK IS WIRED: whether a rating step stands in front of the public link, what a customer is asked, and the shop's own reply-speed target.

private_feedback_enabled IS THE ONE THAT CHANGES WHAT A CUSTOMER SEES. When it is OFF the ask points STRAIGHT AT GOOGLE — every customer, whatever they think of the job — and a shop asking why it collected two one-star reviews this month is usually asking about this switch.

WHEN IT IS ON, THE RATING STEP IS THE FILTER: a happy customer is sent to the public link and an unhappy one is routed to a private note that reaches the owner instead. That is not review-gating dressed up — the low-rating path is a real complaint channel, and reviews.private_feedback is where those land.

connected: false MEANS NOTHING PUBLIC CAN BE COLLECTED AT ALL. The shop has no Google Business Profile linked, so a review ask has nowhere to send anybody and the whole funnel is dead. Say that first.

average_rating and total_review_count are GOOGLE'S OWN whole-history figures cached at the last sync — not a count of the rows this product has synced. Quote them as the public rating; reviews.insights is the read for what the reviews SAY.

THE REPLY TARGETS ARE TWO NUMBERS, NOT ONE, and the tighter one is for the bad reviews. reply_target_hours_low covers 1-3★ and unrated; reply_target_hours_high covers 4-5★. Measure reviews.list rows with no reply against the right one — an unanswered one-star at thirty hours is late, and an unanswered five-star at thirty hours is not.

widget_min_stars is the floor for what appears on the shop's public review wall. A shop showing only 5★ has chosen that, and it is worth knowing before quoting the wall as a rating.

One shop's settings, entirely returned, so nothing is truncated. Changing any of them is a person in Settings → Reviews: these decide what real customers are shown.

Who may call it

Permission: marketing.accessThe caller must hold Reviews & market 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: readCounted against the read budget — the widest of the four.

Input

This capability takes no arguments.

Output

Field	Type	Description
connected	boolean	—
location_title	string \| null	—
average_rating	number \| null	—
total_review_count	number \| null	—
first_synced_at	string \| null	—
private_feedback_enabled	boolean	—
private_feedback_prompt	string	—
private_feedback_low_prompt	string	—
reply_target_hours_low	number	—
reply_target_hours_high	number	—
widget_enabled	boolean	—
widget_min_stars	number	—

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/reviews/settings \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/reviews/settings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

// 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/reviews/settings",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    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": "reviews.settings",
    "arguments": {}
  }
}

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 marketing.access.
422	`validation_error`	An argument was wrong. The message names the field.
429	`rate_limited`	Too many read calls. Back off and retry.
500	`internal_error`	Something failed on our side. Nothing was changed.

Operating contract#

Who may call it#

Input#

Output#

Examples#