Skip to main content
Documentation

Quotes

quotes.send_status

Check whether a quote can be sent, and by which channel
Read-onlyRead budget

REST

Shipping
POST /api/v1/quotes/send_status

MCP tool

Live
quotes.send_status

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

Operating contract

THE CALL TO MAKE BEFORE quotes.send. It answers three separate questions the send would otherwise fail on halfway through: can this quote be sent at all, can it go by text, and can it go by email.

can_sms is false with a reason when the customer has no mobile on file or has opted out of texts. can_email is false with a reason when there is no email address. Both being false means there is nobody to send to, and the fix is a customer record change, not a retry.

blocked is set when the QUOTE itself cannot be sent — it has already been accepted, declined or expired, or its valid_until date has passed. A lapsed date is fixable with quotes.extend_validity; an accepted quote is not, and should not be.

ever_sent tells you whether the customer has had this before, which is the difference between 'here is your quote' and 'just following up'.

Who may call it

Permission
quotes.accessThe caller must hold Quotes 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

FieldTypeDescription
quote_idrequiredstringuuid

The quote to check, as returned by quotes.list or quotes.get.

Output

FieldTypeDescription
can_smsboolean

can_emailboolean

sms_reasonstring | null

email_reasonstring | null

blockedstring | null

ever_sentboolean

total_labelstring

number_labelstring

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

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

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

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 quotes.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.