# 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

## API Changes Documents

See the following documents for details of all the API changes, including breaking API changes.

#### November 2025 Feature Wave

#### Version 1 Configurational 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: 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:

```
GET https://docs.enate.net/enate-help/integrations/enate-integrations/apis/api-changes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.