Skip to main content
Documentation

Services

services.set_online

Show or hide one service on the public booking page
WritesSensitiveWrite budget

REST

Shipping
POST /api/v1/services/set_online

MCP tool

Live
services.set_online

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

Operating contract

Its OWN capability rather than a flag on an update, because the consequence is different in kind: this changes what MEMBERS OF THE PUBLIC can see and book, immediately, with nothing between the call and the shop's storefront.

online: true puts the service on the booking page. online: false keeps the row in the catalog — quotable, jobbable, reportable — and takes it off the customer-facing menu.

TURNING SOMETHING OFF DOES NOT CANCEL WHAT IS ALREADY BOOKED. Appointments already taken for it stand; this only stops new ones. If the shop wants existing bookings moved, that is a per-booking decision.

Everything else on the service is left exactly as it was. The flag lives in a settings bag alongside the service's photo, its icon and its per-service booking window, and this merges rather than replacing — a visibility toggle that silently took the photo off the storefront card would be the kind of quiet damage nobody proposed.

Setting it to what it already is succeeds and changes nothing.

Who may call it

Permission
shop.manageThe caller must hold shop.manage 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
service_idrequiredstringuuid

The service, as returned by services.list or services.get.

onlinerequiredboolean

True shows it on the public booking page; false keeps it dashboard-only.

Output

FieldTypeDescription
idstring

namestring

descriptionstring | null

categorystring | null

pricing_modelstring

base_pricenumber | null

duration_minutesnumber | null

cure_time_hoursnumber | null

activeboolean

bookableboolean

addonboolean

tax_exemptboolean

skustring | null

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/services/set_online \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","online":true}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/services/set_online", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "online": true
  }),
});

// 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/services/set_online",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "online": True
},
    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": "services.set_online",
    "arguments": {
      "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "online": true
    }
  }
}

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 shop.manage.
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.