# Changelog

<details>

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

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

</details>

<details>

<summary>[v15] Identity Verification</summary>

The new `IdentityVerification` endpoint creates or resumes an identity verification session and returns a URL that can be used to launch the verification flow.

</details>

<details>

<summary>[v15] 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.

</details>

<details>

<summary>[v15] New endpoints: ExceptionLists &#x26; PromoCodeExceptionLists</summary>

The new `ExceptionLists` and `PromoCodeExceptionLists` endpoints let you retrieve exception lists and exception list items for SKUs, categories, and promo codes.

</details>

<details>

<summary>[v15] 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/155000004765).

</details>

<details>

<summary>[v15] 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` API endpoint—especially with upcoming limits to the legacy Reports API on September 1, 2025.

</details>

<details>

<summary>[v15] Change to Contract Endpoint</summary>

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

* By default, all new partners will see the Scheduled Terms in the Contracts API.
* If you're an existing partner and want to test out the change, add `--header 'IR-Version:15'` or query string parameter `IR-Version=15` or upgrade to version 15.

</details>

<details>

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

On 05 March 2025, the `ZeroPayoutHideReport` field was added to the `Contracts` API endpoint:

* `/Contracts/<Id>`
* `/Contracts`

</details>

<details>

<summary>[v14] New endpoint: Retrieve required banking fields</summary>

The `/WithdrawalSettings/RequiredFields` endpoint allows you to retrieve required banking fields and, optionally, a payment method for a specified country.

</details>

<details>

<summary>[v14] Change to the Catalogs Endpoint</summary>

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

* `/Catalogs`
* `/Catalogs/<CatalogId>`&#x20;

</details>

<details>

<summary>[v14] 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>[v14] 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
```

</details>

<details>

<summary>[v14] New endpoints: Tax Documents</summary>

Four new *Tax Document* endpoints have been added to the *API Reference* tab. They allow you to do the following:

* Retrieve the latest saved tax document from your partner account
* Create a new tax document
* List all tax documents saved to your partner account
* Retrieve a specific tax document by ID

</details>

<details>

<summary>[v14] 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:

</details>

<details>

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

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

</details>

<details>

<summary>[v12] Clicks endpoint has been deprecated</summary>

The `Clicks` endpoint has been deprecated.

</details>

<details>

<summary>[v12] New endpoints: ClickExport &#x26; Jobs</summary>

Two new endpoints have been added that expand and simplify the ability to retrieve click data.

</details>

<details>

<summary>[v12] Catalogs Endpoint Versions Update</summary>

On March 1, 2022, impact.com deprecated all product catalog API endpoints versions 11 and older.

</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/partner-api-reference/partner-v15/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.
