# Changelog This page is for developers who build on VBAPI and want to know what changed in the documentation and the API. Documentation changes are listed below, newest first; API changes are described in [API changes](#api-changes). ## Documentation changes ### October 26, 2026: faster API reference - API reference pages load less data, and documentation pages no longer download the reference's navigation. The sidebar's **VBASoftware APIs** link opens the reference, which has its own sidebar. - Request bodies and responses in the reference show `application/json`, the format VBAPI reads and writes, instead of also listing `text/plain` and `text/json`. - The JSON download of the OpenAPI description moved to [`/static/openapi/vbasoftware.api.json`](/assets/vbasoftware.api.c385ade9eac6330cb4516f0a85b8a7a6f34b5581270043439bddcddab5a39619.2defd4af.json), and **Try it** opens again on every operation. See [Generate an SDK](/developer-portal/reference/generate-sdk#download-the-openapi-description). ### October 26, 2026: simpler navigation - The top bar has five sections, and the links to VBASoftware.com and VBA Intelligence are under **VBA sites**, and in the footer. - In the sidebar, Help and Reference are one group, **Help and reference**, and [Generate an SDK](/developer-portal/reference/generate-sdk) is under **Get started**. The **Get started**, **Playbooks**, and **AI and MCP** headings open their overview pages. - The Contact and Support page is now part of [Support and escalation](/developer-portal/help/support#contact-vba), and its old address, `/contact`, redirects there. ### October 25, 2026: documentation overhaul The portal content was reorganized around getting a first call working, core concepts, and end-to-end playbooks. Code samples are in C#, Python, and TypeScript, and every operation a page names links to its reference page. New pages: - **Get started:** [Welcome](/developer-portal/get-started/overview), [Quick start](/developer-portal/get-started/quick-start), [Credentials and environments](/developer-portal/get-started/credentials-and-environments), and [Try it in the browser](/developer-portal/get-started/try-it). - **Concepts:** [Data model](/developer-portal/concepts/data-model), [IDs, keys and field names](/developer-portal/concepts/ids-and-conventions), [Requests and responses](/developer-portal/concepts/requests-and-responses), [Authentication and tokens](/developer-portal/concepts/authentication), [Pagination and sorting](/developer-portal/concepts/pagination-and-sorting), [Errors and troubleshooting](/developer-portal/concepts/errors), [Rate limits and performance](/developer-portal/concepts/rate-limits-and-performance), and [Search API](/developer-portal/concepts/search). - **Playbooks:** [Overview](/developer-portal/playbooks/), [Onboard a new employer group](/developer-portal/playbooks/onboard-employer-group), [Enroll employees and dependents](/developer-portal/playbooks/enroll-employees), [Enter claims and adjudicate them](/developer-portal/playbooks/claims-intake-and-adjudication), [Bill premiums and apply payments](/developer-portal/playbooks/premium-billing-and-payments), [Member self-service](/developer-portal/playbooks/member-self-service), [Create an authorization](/developer-portal/playbooks/create-authorization), [Disenroll a member or group](/developer-portal/playbooks/disenroll-member), and [Extract data with the Search API](/developer-portal/playbooks/search-extract). - **Reference:** [Glossary](/developer-portal/reference/glossary), [SearchConfig reference](/developer-portal/reference/search-config-reference), [Generate an SDK](/developer-portal/reference/generate-sdk), and this changelog. - **AI and MCP:** [Overview](/developer-portal/ai/overview), [Connect your AI tools](/developer-portal/ai/connect-your-tools), and [Build with AI](/developer-portal/ai/build-with-ai). - **Help:** [FAQ](/developer-portal/help/faq) and [Support and escalation](/developer-portal/help/support). Corrections that affect integrations: - The support field in every response is `debug.activityID`, with a capital `ID`. - Send a descriptive `User-Agent` header (recommended; VBAPI does not currently require it). A missing or wrong `x-api-key` returns `403`. - Create operations return `200`, not `201`. Deletes return `204`, batch updates return `207`, and queued work returns `202`. - List pages start at 1. Search pages also start at 1 (page 0 returns the first page again), and Search rejects `pageCount` above 750. - The SearchConfig reference no longer lists a `COMMISSION` config, which does not exist. Commission data is in `COMMTRANS`, `COMMAGENCY`, and related configs. The previous Guides and AI Features pages are replaced by the pages above. Where the portal supports it, their old addresses redirect to the new pages. ## API changes API changes (new, changed, and removed operations) are not listed here yet. The API reference is regenerated from the VBAPI OpenAPI description each time it is updated, so the [API reference](/openapi/vbasoftware/vbasoftware.api) always shows the current operations. A per-release list of API changes, produced by comparing successive versions of the description and highlighting breaking changes such as removed operations and renamed parameters, is planned for this page. Until it is in place, compare the description you generated a client from with the current one (see [Generate an SDK](/developer-portal/reference/generate-sdk)), or ask VBA through [Support and escalation](/developer-portal/help/support).