> For the complete documentation index, see [llms.txt](https://docs.enate.net/enate-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enate.net/enate-help/integrations/enate-integrations/apis/api-changes.md). # API Changes This section gives a list of changes to Enate's APIs from version 2024.1 and above. ## What is a breaking change? With each release of Enate (both major and minor), the changes to Enate's APIs may also include breaking changes. Examples of breaking changes are: * Changes to the URL or fundamental request/response associated with a resource * Removal, rename, or change to the type of a declared property * Removal or rename of APIs or API parameters * Addition of a required request header * Addition of a required API parameter Examples of changes which are NOT considered breaking changes and are outside the scope of this document are: * Addition of properties that are nullable or have a default value * Addition of an optional API parameter * Addition of a member to an enumeration * Removal, rename, or change to the type of an open extension * Removal, rename, or change to the type of an annotation * Introduction of paging to existing collections * Changes to error codes * Changes to the order of properties * Changes to the length or format of opaque strings, such as resource IDs ## Choosing the version you call Enate keeps earlier API versions available so that an existing integration keeps working when a new version is released. You choose the version with the `api-version` query string parameter: ``` POST https://yourplatform/operational/Ticket/Create?api-version=3 ``` | Behaviour | Detail | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | Latest stable version of the Operational API | 3 in the July 2026 Feature Wave | | Latest stable version of the Configuration API | 3 in the July 2026 Feature Wave | | If you leave `api-version` off a request | Enate applies the latest stable version for that API rather than rejecting the request | | Versions numbered above the latest stable one | Previews of a future contract. Swagger marks them as preview, and they can still change before release | | Where to see the versions your instance exposes | Swagger. Enate doesn't return the available versions in a response header | {% hint style="warning" %} **Send `api-version` explicitly on every request.** The latest stable version moves on when a feature wave makes a new version stable, so an unversioned request quietly starts resolving to the new contract. Leaving the parameter off puts Enate in charge of when your integration changes version, rather than you. {% endhint %} Don't build a production integration against a preview version. A preview exists so you can see what's coming and give feedback, and the contract can change before it becomes stable. ## What a released version guarantees Once a version has been released, the whole of it is frozen. Endpoints, request and response shapes, property names and types, and the enumeration values behind them all stay as they are in that version for as long as the version is available. New work goes into the newest version instead, which is why everything in the second list above is safe: an addition can't reach an integration that's pinned to an older version. That's what makes pinning worth doing. An integration built and tested against version 3 keeps getting version 3's contract, and you decide when to move. There's one consequence worth planning for. Enate holds one set of values internally, and where the version you called has no member for a value Enate needs to return, the request is rejected with a 400 rather than returning a number the version doesn't define. The API Enums page covers what that response looks like and what to do about it: {% content-ref url="/pages/-McjNI1qFp\_MXXsb03k\_" %} [API Enums](/enate-help/integrations/enate-integrations/apis/api-enums.md) {% endcontent-ref %} {% hint style="info" %} One field is outside the freeze. The `RelatedObjectType` field on a validation message carries the `EnateObjects` enumeration, which isn't frozen per version, so a new Enate object type can appear in that field on an older API version. Treat an `EnateObjects` value you don't recognise as informational rather than letting it fail your handler. {% endhint %} ## Rate limiting Enate's APIs are rate limited. An integration that exceeds the limit receives HTTP 429 Too Many Requests, with no `Retry-After` header, and needs to back off and retry. This isn't a change to any request or response contract, but it does change how an integration written against an earlier release behaves under load, so review the pacing of anything that sends requests in bulk. The limits and the recommended client behaviour are on the APIs page: {% content-ref url="/pages/-MWitGruK-\_yfZirn2ke" %} [APIs](/enate-help/integrations/enate-integrations/apis.md) {% endcontent-ref %} ## API Changes Documents See the following documents for details of all the API changes, including breaking API changes. #### April 2026 Feature Wave #### Version 1 Configuration - Version 2 Configuration API Changes {% file src="/files/qh8KdnusLHLrnHRIMg4S" %} #### Version 1 Operational - Version 2 Operational API Changes {% file src="/files/Skjt8Ak8OEB8aESNqt04" %} *** #### November 2025 Feature Wave #### Version 1 Configuration API {% file src="/files/rfI3HR9Jwqs2GNBqekqf" %} #### Version 1 Operational API {% file src="/files/Qr68IY6OY3nj0KifgDWN" %} #### 2024.1 Legacy API {% file src="/files/UKH7ojFo61YLoR9Zc6rH" %} #### v2024.1 {% file src="/files/lN26dIvWov4SjCEC0HJR" %} ## How to use the API Changes document Recommendations for how best to use the breaking changes document information to highlight where you may need to make changes to your code which involves Enate APIs. Recommendation for best use of API breaking changes documentation is as follows: * Read through the breaking changes information for APIs. * Upon finding reference to an API which you currently use and which has changed, go to your Swagger environment for the quickest way to view the overall impact and new API content definition. Your Swagger environment should always be your go-to place for the definitive explanation of the current API structure.\ See the [Swagger explanation section](https://docs.enate.net/enate-help/integrations/enate-integrations/apis#swagger-enates-interactive-api-documentation) for more info. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.enate.net/enate-help/integrations/enate-integrations/apis/api-changes.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.