Versioning

When backward-incompatible changes are made to the API, a new, dated version is released. The current version is 12 (2021-08-05). A change is considered backward-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 partner account API settings unless you override the API 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 partner 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.

❗️

Warning

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/Mediapartners/<AccountSID>/Actions' \
    -d 'IrVersion=12' \
    -G
curl 'https://api.impact.com/Mediapartners/<AccountSID>/Actions' \
    -H 'IR-Version: 12'