marketing.reactivation_config

Read the rules the automatic win-back campaign texts under

Read-onlyRead budget

REST

Shipping

POST /api/v1/marketing/reactivation_config

MCP tool

Live

marketing.reactivation_config

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

Operating contract

THE GUARD RAILS ON THE WIN-BACK RAIL: whether it runs at all, how long a customer is left alone between attempts, how many times one person may ever be chased, how many go out shop-wide in a day, and the hours of the day it is allowed to send in.

enabled: false IS THE DEFAULT AND IT MEANS NOTHING IS BEING SENT. A shop wondering why old customers are not coming back is usually looking at a rail nobody switched on.

send_window_start_hour AND send_window_end_hour ARE WHY A TEXT DID NOT GO OUT WHEN SOMEBODY EXPECTED. They are the shop's local hours, and a campaign queued at eight in the evening against a window closing at eight waits until morning — which looks exactly like a broken rail.

require_marketing_consent: true IS THE COMPLIANCE SETTING AND ITS DEFAULT IS ON. With it on, a customer who never agreed to marketing is never texted by this rail however long since their last visit. Turning it off is a decision with legal weight, and customers.consent_standing is where an individual customer's standing is.

max_reactivations is a LIFETIME ceiling per customer, not a per-campaign one. Somebody chased three times and still silent is somebody this rail has finished with.

daily_cap_per_shop bounds the whole shop per day, which is what keeps a first run from texting an entire book at once — and it is also why a large campaign takes days rather than minutes.

One shop's settings, entirely returned, so nothing is truncated. Changing them is a person in Settings, because every one of these numbers decides how often real customers are messaged.

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
enabled	boolean	—
cooldown_days	number	—
max_reactivations	number	—
daily_cap_per_shop	number	—
require_marketing_consent	boolean	—
send_window_start_hour	number	—
send_window_end_hour	number	—
timezone	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.

curl

export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/marketing/reactivation_config \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/marketing/reactivation_config", {
  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/marketing/reactivation_config",
    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": "marketing.reactivation_config",
    "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#