API Changelog
What changed in the API, newest first. Back to the reference
- Streaming chat has its own name. Send streaming
chat to
https://stream.everycallhandled.com/. It takes the same request and the sameAuthorizationheader as before, and answers in the same way. The previous address keeps working, so nothing breaks, but it may be retired later: move to the new name when you next touch your integration. See Stream a Chat Message.
- Twenty-nine more quiet routes are retired. The old
user-administration routes (
POST /createTFUser,/createTFUserAndSpace,/getTFUserOrgIdByEmail,/getUserExistsByEmail,/listcognitousers,/updatecognitouserattributes,/updatecognitouserpreferredspaceid,/passwordlessConfirmAndLoginUser), the old calendar routes (POST /checkForSecureCredentials,/createCalendarEvent,/deleteCalendarEvent,/gcalconnect,/gcaldisconnect,/getUserAvailabilitySlotsByDay,/syncCalendarEvents,/updateCalendarEvent), the workflow and human-task routes (POST /workflowcancel,/workflowschedule,/human-tasks/complete,GET /human-tasks) and nine older platform routes (POST /acladd,/aclharddelete,/aiengine,/ai-engine-enhanced,/processAtomfile,/schema,/sendemailtousersingroup,/uploaduserfile,GET /health) now answer410 Gonewith the route and the date. None had been called for over 30 days and none was part of this guide. Team members are managed with/api/v1/users, calendars connect through the booking settings, and knowledge uploads usePOST /api/v1/apps/{appId}/knowledge. The code behind them may be removed after 90 quiet days, from 30 January 2027. If you still depend on one, write to support with the route name before then. See Retired routes. - The early developer API and three old callback and device
routes are retired.
POST /api/v0/oauth/authorize,POST /api/v0/oauth/query/{sid},GET /cbgcal,POST /processeventlogandPOST /signalheartbeatnow answer410 Gonewith the route and the date. None had been called for over 30 days and none was part of this guide. Use an API key with the/api/v1routes in place of the developer API; calendars connect through the booking settings. The code behind them may be removed after 90 quiet days, from 30 January 2027. If you still depend on one, write to support with the route name before then.
- Fourteen legacy Stripe payment routes are retired.
POST /stripecancelauthorization,/stripecapturepayment,/stripecreateaccount,/stripecreatepaymentintent,/stripecreatepayout,/stripegetaccountlink,/stripegetdashboardurl,/stripegetonboarduserstatus,/stripegetpaymentactivity,/stripegetpublickey,/stripeonboarduser,/stripeplatformtransfer,/striperefundpaymentand the per-merchant webhook/stripewebhook/{domain}now answer410 Gonewith the route and the date. None had been called for over 30 days and none was part of this guide; payments and payouts run through the Stripe Connect flow and the billing routes. Their code is removed after 90 quiet days, from 28 January 2027. If you still depend on one, write to support with the route name before then. See Retired routes.
- A retired route answers 410 Gone instead of
vanishing.
POST /aiengine2andPOST /loadwebpagewere retired on 28 October. A retired route keeps its sign-in and returns410with a JSON body naming the route, the retirement date and what to do, so a caller we did not know about learns exactly what happened. Every hit is logged, never the body. Details under Retired routes.
- Embed codes point at the live widget host.
GET /api/v1/apps/{appId}/embed-codenow builds its iframe snippet from the live widget host. A snippet copied before 27 October may point at an older host: copy it again from the route or the dashboard.
- Call and chat analysis has a backup model. When the primary analysis model is unavailable, the summary, the caller details and the outcome of a call or chat come from a backup model instead of going missing. Nothing changes in the fields you read.
- An app can switch its own call recording off. Set
voiceChatTools.recording.enabledtofalseon the app (PATCH /api/v1/apps/{appId}) and that app's calls are not recorded; unset means recording stays on, as before.GET /api/v1/apps/{appId}/conversations/{chatId}/recordingreturns404for a call made while recording was off. The attribute is in the voice attribute reference.
- Assistants built from a website carry its facts word for word. The site's own phone number, address, email and opening hours are copied exactly as written, with their source recorded, and the assistant says them as they are. A build may also be made with no phone number of its own, for an assistant that lives on web chat or a page.
- Intake by text: uploads and signatures by secure link. On SMS and WhatsApp, an upload or signature step sends a short link that opens the step in the browser (one use, 24 hours). A signature carries the conversation on by text without the customer having to write again, and a statement not yet signed gets one reminder by text.
- Plain characters in every text. Curly quotes, long dashes, ellipses and ticks are swapped for plain characters before a text is sent, so one special character no longer doubles the cost of a message.
- Sign-in tokens never reach the logs. Request logging redacts bearer tokens and session values everywhere.
- Minute packs are credited to the account automatically. A pack bought with the email of an existing account lands in that account's pool at once, with a ledger row and a receipt by email. A pack bought under an email that has no account yet is held and credited within fifteen minutes of the account existing, and never twice.
- Texts and emails in the customer's language. The booking steps by text answer in the language the customer writes in, and every later text and email to that customer is translated and checked before it is sent; otherwise English, as before.
- Internal hooks refuse calls from the web. The platform's internal webhook hooks are no longer reachable from the public internet. Public webhooks and your own custom destinations are unchanged.
- WhatsApp: connect your own number in one step, and bookings with tappable times. The dashboard's one-button connect keeps the number's own id, so a connected number stays connected. A booking proposal by WhatsApp arrives as tappable times and review buttons, and a typed yes still confirms. Call summaries can also be sent to a Telegram channel from the dashboard's Channels page.
- Links in texts use a short host. Links sent by text come from a short host, so they fit in a message and read as the brand that sends them.
- Photos on a booking from the customer area. A customer can add photos to a booking from the link in their text, and a step that has already asked for them is not asked again.
- Every customer text costs one text. A text or WhatsApp message to a customer is charged at the text rate (30 credits by default), whether the assistant wrote it or a booking step did; a reply on the text channel costs a text, not a web-chat message. Verification codes and platform alerts are free, and an app that texts through its own Twilio account is not charged by the platform for that message.
Text messages and WhatsApp get real conversations. A text thread now closes after fifteen minutes of quiet and the next message opens a new conversation carrying a summary of the last, so
GET /api/v1/apps/{appId}/conversationsreads one row per occasion instead of one endless row per customer. The id keeps the customer's thread as its prefix and gains-s2,-s3; group by that prefix or bycallerIdPhone. A conversation taken over by a team member does not roll while they are handling it.A text conversation is visible as it happens. Conversations now carry
source: "sms"or"whatsapp"and the customer'scallerIdPhonefrom the first message, and appear in the list the moment they start rather than once they have been summarised. Both dashboards show the channel on the row.HELP, STOP and START are answered by the platform.
HELPandINFOreturn one fixed line built from the app's name and the number texted.STOPand its variants now record the opt-out on the customer's record asconsents.reminders.sms = false, and every outbound text path consults it: the reminder sweep skips that customer and writesskipped:opted-outagainst the rule.STARTlifts it. Previously the platform relied on the carrier's own block, which only covers the pair of numbers that saw the STOP — and reminders go out from a different number than the one customers text. An opt-out from texts leaves email and phone reminders, and marketing consent, untouched.The assistant knows it is on a text message. It is told the channel and the sender's number, so it writes the way a person texts and never asks for a number it already has. On SMS it answers in words rather than cards or pickers; WhatsApp still renders them as native tappable lists.
Longer conversations answer from the right end. Stored conversation history was being read oldest-first and capped, so a long-running thread could answer from months-old context and miss what was just said. Every channel now reads the most recent turns.
See what your reminders did. A phone reminder now appears in the conversation list with
source: "reminder-call"and areminderblock (bookingId,ruleKey,attempt,outcome), onGET /api/v1/apps/{appId}/conversationsand the single-conversation read. Each booking'scommsSentmarkers keep the conversation id, the call length and any note.GET /api/v1/apps/{appId}/booking-reportsgainsreminders: counts by channel for the window and, for calls, how many were reached and what came of them.Hear the reminder call first.
POST /api/v1/apps/{appId}/booking/reminder-call/previewreads back the exact spoken lines and persona a reminder would carry, with a sample booking and optionally an unsavedcallsblock;POST .../reminder-call/testrings a number you give with that same call and records nothing against any booking. Both in Bookings, Messages, under the phone call section, alongside the quiet hours for texts and emails.
Outbound persona for phone reminders. A reminder call no longer borrows the inbound receptionist's instructions; it speaks with the platform's outbound manner (says who it is, asks for the customer by name, one sentence at a time, never the inbound greeting). Each app can now set the outbound voice, its own words for the opening, the language it opens in, how quickly it takes its turn and the recording notice, under
booking.comms.calls.personainPUT /api/v1/apps/{appId}/bookingand in Bookings, Messages, Phone call reminders. Nothing changes for inbound calls.Build a demonstration from a website.
POST /api/v1/apps/build-from-website(operators) reads a business's public site and builds a demonstration receptionist from it: a published app, a phone number, a booking page in the business's own branding, web chat and the site as knowledge. The app carries demonstration mode (booking.demo): the receptionist discloses it is a demonstration on every call and chat, gives no clinical advice and no suitability judgement, messages nobody, and the booking page banners and confirms bookings as demonstrations (config.demo).Demonstration landing page and funnel. Each built demonstration gets a landing page (
landingUrl) with the number, the booking page, the web chat and the proof layer. Pages report visits throughPOST /api/v1/public/demo-visit.GET /api/v1/demos/funnellists every demonstration with visits, return visits, calls and call time, web chats, booking attempts, furthest stage and last activity;PATCH /api/v1/demos/{appId}records replied and notes.Demonstration cap and teardown. A demonstration is built with a call-time allowance (
creditSeconds, default 30 minutes) allocated from the operator's pool, and a life (demoDays, default 14). A daily sweep ends demonstrations whose time is up: the number answers with an ended message, the receptionist is paused, the booking page shows the ended notice; two weeks later the operator is told it can be deleted.PATCH /api/v1/demos/{appId}takesextendDaysandend.The instantly.ai export.
GET /api/v1/demos/export.csvgives one row per live demonstration with the merge fields, a cohort question, a PECR column (limited companies only, unless consent is recorded) and the opt-out line; contact and company details are set at build or withPATCH /api/v1/demos/{appId}.
- Reminders by text, email or phone call. Each
reminder rule in the booking settings now chooses its channel:
reminders[].channelissms(the default, so nothing changes for existing apps),emailorcall, and the follow-up hasfollowUpChannel(smsoremail). Email reminders and follow-ups go out as branded emails with the manage link. A call rule has the receptionist ring the customer to confirm attendance, offer to move the appointment, or take a cancellation if you allow it; never money. The newcomms.callsblock holds what the call may do, four short scripts with the usual merge tags, the call window, attempts and retry gap, the fallback channel and the identity check, all with defaults. - The message trail. A booking's
commsSententries are now objects (at,channel,attempt,status,fallbackSent) carrying call outcomes andskipped:<reason>values; the old timestamp form still reads as a text sent. Send-log rows carrychannelandstatus. A customer who asks not to be rung getsconsents.reminders.call: falseon their record and their reminders go to the fallback channel. See "Instant Confirmations & Booking Messages" under Bookings.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.