# Changelog

<details>

<summary>[v14] Change to Programs Endpoint</summary>

The `Programs API` endpoint now has a `type` string field to differentiate between campaign formats.

</details>

<details>

<summary>[v13] New feature: Application Processing API</summary>

The contracts endpoint now has two new methods:

* `POST` support for new partner applications. You can now accept pending application proposals and optionally assign a `groupId` to each newly accepted partner.
* `DELETE` support for new partner applications. You can now decline pending application proposals and optionally pass `reason` and `groupId` parameters.

</details>

<details>

<summary>[v13] Rate Limit Changes for ReportExport and ClickExport</summary>

The new rate limits on API requests are:

* `ReportExport`: 100 requests per day.
* `ClickExport`: 10 requests per day.

However, these new limits won't be enforced for many brands until the new year.

</details>

<details>

<summary>[v13] New endpoint: PromoCodeExceptionLists</summary>

The `PromoCodeExceptionLists` endpoints let you create, update, retrieve, and delete promo code exception lists.

</details>

<details>

<summary>[v13] Scoped Tokens</summary>

impact.com lets you create scoped tokens: API credentials with detailed, fine-tuned permissions that limit or allow access to specific API endpoints. This improves security, enhances access control, and simplifies token management.

To get started, explore:

* [Best practices for scoped tokens](https://help.impact.com/en/support/solutions/articles/155000005478).
* [How to migrate to scoped tokens](https://help.impact.com/en/support/solutions/articles/155000005518).
* [How to manage API access effectively](https://help.impact.com/en/support/solutions/articles/155000004762).

</details>

<details>

<summary>[v13] Migrate to ReportExport</summary>

If you export large volumes of report data via the impact.com API, now is the time to switch to the more efficient `ReportExport` endpoint—especially with upcoming limits to the legacy Reports API on September 1, 2025.

</details>

<details>

<summary>[v13] New endpoint: Upload</summary>

The new `Upload` endpoint allows you to upload a catalog via API. You can now upload an entire catalog instead of updating records one by one.<br>

</details>

<details>

<summary>[v13] Changes to Contract Endpoint</summary>

The `Contracts API` endpoint now includes Scheduled Terms. When relevant, API responses will contain an additional JSON object: `ScheduledTerms`.

</details>

<details>

<summary>[v12] Improvements to the /Ads endpoint</summary>

We've enhanced the `/Ads` endpoint to give you more control over how you can retrieve your ad details from impact.com:

* The as endpoint now returns an ad's `DateCreated` and `DateLastUpdated`.
* When retrieving ads, you can now specify the creation/update date or date range for which you want results to be returned.

We've also made some changes to managing your banner ad's creative assets. You can add or update a banner ad's creative file using the `BannerCreativeFile` parameter when you create or update an ad.

</details>

<details>

<summary>[v12] Change to Contracts Endpoint</summary>

On 05 March 2025, the `ZeroPayoutHideReport` field was added to the following brand endpoint:

* `/Contracts/<Id>`

</details>

<details>

<summary>[v12] Change to Catalogs Endpoints</summary>

On 12 September 2024, the `Currency` and `ServiceAreas` fields were added to the following brand endpoints:

* `/Catalogs`
* `/Catalogs/<CatalogId>`

</details>

<details>

<summary>[v12] New endpoint: LegalEntities</summary>

The new `LegalEntities` endpoint allows you to retrieve legal entity information, including billing address and indirect tax details, for [legal entities](https://help.impact.com/en/support/solutions/articles/155000002556-create-manage-your-legal-entities) associated with your account.

</details>

<details>

<summary>[v12] Changes to the Create a Partner endpoint</summary>

On 23 August 2024 these changes were implemented to the Create a Partner endpoint:

* Updated the order of the parameters to match the actual code.
* Added `PhoneNumber` as a parameter
* Deprecated `PromotionalMethods`
* Updated descriptions for `TaxId` and `OrganizationType`

</details>

<details>

<summary>[v12] Changes to actions and action updates</summary>

On 5 August 2024 these changes were implemented to ensure data integrity and optimize API performance:

* Queries for `Actions` or `ActionUpdates` cannot have a `StartDate` exceeding 3 years in the past.
* A query’s `StartDate` and `EndDate` cannot be more than 45 days apart.
* If no `StartDate` and `EndDate` parameters are specified, only records for the past 7 days will be returned.
* If `StartDate` is specified, `EndDate` must be specified as well, or the query will return an error.
* The new default page size is 20,000 records per page when `PageSize` isn’t specified.
* If specified, the smallest `PageSize` value is 2,000 records.
* If the total record count exceeds 10 times the page size, an error message will prompt you to either adjust either the `PageSize` or the `StartDate` or `EndDate`, to ensure the response won’t contain more than 10 pages.

</details>

<details>

<summary>[v11] Ensure your data is always fresh!</summary>

Previously, you may have run the risk of receiving incorrect or outdated information if your client cached data in your API requests, especially for dynamic, user-specific, or time-sensitive data. You will now receive the following header values to indicate to your client that the response data from your queries should not be cached, and ensure that you always fetch the latest data:

```
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
```

Ensure that your data is always fresh by checking that your API client expects these new header values.

</details>

<details>

<summary>[v11] Deferred Response Endpoint</summary>

The `Deferred Response` endpoint can be used to create or replay `/report` or `/clicks` jobs.

</details>

<details>

<summary>[v11] Changes to the Reports endpoint pagination</summary>

After 2 October 2023, any requests made to the Reports API endpoint that specify a page size other than 20,000 will return a page size of exactly 20,000 records. If any of your integrations with the /Reports API specifies a page size less than 20,000, we recommend either of the following updates:

* Specify a `PageSize` of 20,000.
* Remove the `PageSize` parameter from the request altogether.

</details>

<details>

<summary>[v11] New endpoint: Export a Report</summary>

There is a new endpoint in the reports section of our API reference documentation.

The `ReportExport` endpoint schedules a job to export reports asynchronously.

</details>


---

# 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://integrations.impact.com/brand-api-reference/brand-api-reference-v11/readme/changelog.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.
