API Changelog
What changed in the API, newest first. Back to the reference
2026-08-20
- The booking record, documented. Every booking's
evidence trail has been API-accessible since 12 August and is now in
this guide:
GET …/bookings/{bookingId}/record(checklist, work details, permanent notes) plusrecord/delivery(line-by-line what was done and used — item, product, batch, expiry, quantity, price),record/note(append-only, stamped; corrections are new notes referencing the old — nothing can ever be edited or deleted), andrecord/artefact(mark a checklist item completed, or waive it with a required written reason). See "The Booking Record" under Bookings. - Gift vouchers and promo codes on the hosted booking
page. New public routes
voucher-checkout(buy a voucher through your connected Stripe; the code is emailed on payment),voucher-checkandpromo-check;confirmacceptsvoucherCodeandpromoCode. A voucher that covers the deposit pays it outright; smaller ones are noted on the booking for the till. - Instant booking confirmations. Every booking sends
an email and/or SMS confirmation the moment it exists, with
cancel/reschedule notices from any direction. Messages say "reserved"
while a deposit link is outstanding and "confirmed" only once nothing is
owed. Opt out with
"confirmationComms": false. - The details step is yours to shape.
detailFields(DOB, gender, address, practitioner note, marketing consent — each optional/required per app) andnewClientGate(steer first-timers to a consultation, server-enforced) on the booking settings. - Your voice: every customer-facing line is
configuration. Greeting style (friendly/formal), per-service
deposit wording, voucher redemption note, promo note, consent ask,
cancellation policy — all on the booking settings
PUT, all with sensible defaults, gathered in the dashboard's new "Your voice" panel.vocabularynow takesclinic,salon,tradesorhospitalityand picks vertical-correct default wording for anything left blank; the publicconfigprojection includes the resolvedvoiceDefaults.
2026-08-18
- The built-in diary is documented end to end. The
Bookings chapter now covers the platform-hosted diary: services with
per-weekday hours (
dayWindows), multiple diary lanes, the hosted booking page with its share link, QR and embed snippets, and the moderated review store. - Public booking API. The unauthenticated surface
behind the hosted page is documented for custom front ends:
/api/v1/public/book/{appId}/config | slots | hold | confirm | release, signed customer manage links, and public reviews. - Operator diary API. The diary window read, manual
bookings and private blocks (
POST /bookings/create), cancel/reschedule/notes, the report pack (GET /booking-reports), and the customer directory with duplicate merge (/parties,/parties/{partyId}/merge). - NEW: Close dates in one call.
POST /api/v1/apps/{appId}/bookings/close-datesblocks out an inclusive date range — one lane or all — as full-day private blocks. Past days are skipped and existing bookings are left in place, with the response listing exactly what was created. - NEW: Ask page.
POST /api/v1/apps/{appId}/ask-pagemints (or returns) the app's QR-ready hosted chat page. Documented under Go Live, with the matching dashboard button.
2026-07-25
- Chat answers can now stream. A new Server-Sent
Events endpoint delivers chat responses token by token using the same
Authorizationheader as the rest of the API — no more waiting out long tool-driven turns. See "Stream a Chat Message" in the Chat API chapter. - The buffered chat endpoint is documented
accurately.
conversationIdanduserIdentifierwere always required; the example and response shape now show the real contract.
2026-07-19
- Auto top-up is now documented and available at two
scopes. Keep a shared account pool topped up
(
GET/PATCH /api/v1/accounts/{merchantId}/auto-topup) or protect a single app's balance (GET/PATCH /api/v1/apps/{appId}/auto-topup). Reads report whether a card is on file and which balance the setting governs. - Remove a per-app spending cap.
POST /api/v1/apps/{appId}/cap-removereturns an app's remaining cap balance to the shared pool and makes the app uncapped again — the inverse of cap top-up.
2026-07-17
- Manage your whole account by conversation. The admin assistant (Teach) can now create and configure apps, manage team members, buy credits, connect a calendar, and change plans — every money-spending or destructive action asks for explicit confirmation first.
2026-07-16
- Team lifecycle endpoints. Invite
(
POST /api/v1/users), change a role (PATCH /api/v1/users/{userId}), pause and resume sign-in (POST /api/v1/users/{userId}/pause), and remove a teammate (DELETE /api/v1/users/{userId}). Role changes are bounded by your own role. - Buy credits from your integration.
POST /api/v1/billing/topup-sessionreturns a hosted checkout link priced at your plan's per-minute rate. - Take an app offline.
POST /api/v1/apps/{appId}/unpublishremoves the published site without deleting the app. - List upcoming bookings.
GET /api/v1/apps/{appId}/bookingsreturns the operator view of appointments.
2026-07-15
- Web-chat components: render contract + curated
library. Saved actions can declare how their data renders in
chat (
cards,comparison,timeline), and you can pre-approve exact content that the assistant serves verbatim. - Scoped API keys. Self-mint hash-stored keys scoped to chat, knowledge or forms, and list or revoke them — see Scoped API Keys.
2026-07-13
- Buy a phone number from the API.
POST /api/v1/apps/{appId}/phone-numberpurchases and wires a number in one call, with automatic rollback if wiring fails;DELETEreleases it. - Automation rates are live. Workflow runs are billed per run plus per step-class; the launch rate table is published in the Workflow Execution section.