Skip to main content
Documentation

Customers

customers.set_marketing_consent

Turn marketing messages to a customer on or off
WritesSensitiveWrite budget

REST

Shipping
POST /api/v1/customers/set_marketing_consent

MCP tool

Live
customers.set_marketing_consent

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

Operating contract

Flips the switch that decides whether this shop's campaigns and marketing automations may reach this customer.

THIS IS THE SWITCH, NOT THE EVIDENCE. customers.record_consent records WHY the shop may message them and since when; this records the decision. Turning the switch on without a basis on file is legal exposure the shop carries, so record the basis too.

TURNING IT ON IS THE SENSITIVE DIRECTION and the one to be sure about: it puts somebody back into every campaign the shop runs. Only do it when a person has actually asked for it, and never to 'fix' a customer who stopped receiving messages.

It does NOT clear sms_opt_out. Somebody who replied STOP stays stopped — that is a carrier-level refusal and reversing it is theirs to do, not the shop's.

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
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
customer_idrequiredstringuuid

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

marketing_consentrequiredboolean

True to allow marketing messages, false to stop them.

Output

FieldTypeDescription
idstring

marketing_consentboolean

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

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/customers/set_marketing_consent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "marketing_consent": 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/customers/set_marketing_consent",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "marketing_consent": 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": "customers.set_marketing_consent",
    "arguments": {
      "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "marketing_consent": 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 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.