Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is 11 (2022-10-12). A change is considered backwards-incompatible when under the following conditions:

  • Resources or fields are removed from responses
  • The meaning (Type) of an attribute changes

Note that the version of an API does not increase when new resources are added or when new fields are added to a resource.

All requests use your account API settings, unless you override the API version. The changelog lists every available version.

To set the API version on a specific request, you can add the IrVersion query string parameter or IR-Version header.

You can visit your account API settings to upgrade your API version. As a precaution, use API versioning to test a new API version before committing to an upgrade.

❗️

Upgrading your current account API version may break existing API calls that you have in place. As such, use caution when upgrading versions.

Versioning Examples


curl 'https://api.impact.com/Advertiser/<AccountSID>/Actions' \
	-d 'IrVersion=11' \
	-G
curl 'https://api.impact.com/Advertiser/<AccountSID>/Actions' \
	-H 'IR-Version: 11'