Skip to content

Operator Site FAQs API (1.0.0)

API for operators to manage a venue's public-facing FAQ list, and for partners to read it.

FAQs are a JSON array of {question, answer} items stored per venue. question/answer values are plain strings and may contain markdown syntax (e.g. **bold**, links, lists); the server does not parse or sanitize markdown — it is rendered client-side.

The venue is identified by its composite ID — {venueGroupId}|{rmsSlug}|{venueId} — and the caller's venue-group ownership of (or partner mapping to) that venue is enforced server-side.

Verbs:

  • GET returns the current FAQ array (empty array when none stored). Readable by operators and mapped partners.
  • PUT replaces the whole array — this is also the bulk-import mechanism for a single venue's full FAQ list.
  • PATCH applies an RFC 6902 JSON Patch document against the array (item-index pointers, e.g. /0/answer, or /- to append).
  • DELETE wipes the stored array. Idempotent.
  • POST /venues/site-faqs/bulk applies changes across many venues in one transaction (all-or-nothing).
Download OpenAPI description
OperatorSiteFaqsApi.json
OperatorSiteFaqsApi.yaml
Languages
Servers
Live
https://api.bookabletech.com

operator-site-faqs

Public-facing FAQ list attached to a venue, owned and managed by the operator, readable by mapped partners.

Operations