Changelog
[v16] Partner Conversions endpoint added
The Conversions endpoint lets you submit your conversion transactions directly through the API.
[v16] Change to Programs Endpoint
The Programs API endpoint now has a type string field to differentiate between campaign formats.
[v15] Identity Verification
The new IdentityVerification endpoint creates or resumes an identity verification session and returns a URL that can be used to launch the verification flow.
[v15] Rate Limit Changes for ReportExport and ClickExport
The new rate limits on API requests are:
ReportExport: 100 requests per day.ClickExport: 10 requests per day.
[v15] New endpoints: ExceptionLists & PromoCodeExceptionLists
The new ExceptionLists and PromoCodeExceptionLists endpoints let you retrieve exception lists and exception list items for SKUs, categories, and promo codes.
[v15] Scoped Tokens
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:
[v15] Migrate to ReportExport
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.
[v15] Change to Contract Endpoint
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 parameterIR-Version=15or upgrade to version 15.
[v14] Change to Contracts Endpoint
On 05 March 2025, the ZeroPayoutHideReport field was added to the Contracts API endpoint:
/Contracts/<Id>/Contracts
[v14] New endpoint: Retrieve required banking fields
The /WithdrawalSettings/RequiredFields endpoint allows you to retrieve required banking fields and, optionally, a payment method for a specified country.
[v14] Change to the Catalogs Endpoint
On 16 September 2024, the Currency and ServiceAreas fields were added to the following partner endpoints:
/Catalogs/Catalogs/<CatalogId>
[v14] Changes to actions and action updates
On 5 August 2024 these changes were implemented to ensure data integrity and optimize API performance:
Queries for
ActionsorActionUpdatescannot have aStartDateexceeding 3 years in the past.A query’s
StartDateandEndDatecannot be more than 45 days apart.If no
StartDateandEndDateparameters are specified, only records for the past 7 days will be returned.If
StartDateis specified,EndDatemust be specified as well, or the query will return an error.The new default page size is 20,000 records per page when
PageSizeisn’t specified.If specified, the smallest
PageSizevalue 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
PageSizeor theStartDateorEndDate, to ensure the response won’t contain more than 10 pages.
[v14] Ensure your data is always fresh!
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:
[v14] New endpoints: Tax Documents
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
[v14] Changes to the Reports endpoint pagination
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:
[v12] New endpoint: Export a Report
There is a new endpoint in the reports section of our API reference documentation.