Skip to main content
Ask ChatGPT

API Deprecation Policy

Aprimo is committed to giving developers sufficient time to prepare for breaking changes. This page describes our deprecation policy, what qualifies as a breaking change, and how notices are communicated.

Our Commitment​

When Aprimo plans to deprecate an API or enable a breaking change, we will provide at least 6 months of advance notice before the change takes effect.

This notice period gives your team time to evaluate the impact, update your integrations, and test in a non-production environment before the change is enforced.

What Counts as a Breaking Change​

This policy applies to publicly documented APIs and their documented details. A breaking change is any modification to a documented API — or a documented aspect of that API — that could cause an existing, correctly-written integration to stop working or behave differently without code changes.

Examples of changes covered by this policy:

  • Removing or disabling a documented API endpoint or authentication route
  • Removing support for a documented OAuth flow type or token format
  • Changing documented required request parameters or authentication headers
  • Removing or renaming documented response fields

Changes to undocumented APIs or undocumented details of a documented API are not subject to this policy. Aprimo reserves the right to modify or remove functionality that has not been publicly documented without advance notice.

Minor additive changes — such as adding new optional fields to a response, adding new endpoints, or improving error messages — are not considered breaking changes regardless of whether they are documented.

After the Deprecation Date​

Once the announced deprecation date passes, deprecated functionality is no longer supported. Any integrations that continue to rely on deprecated APIs do so at their own risk.

If your integration is affected by an upcoming deprecation, complete your migration before the announced date.

Reach out to your Aprimo Customer Success Manager for any assistance or guidance.

How Notices Are Communicated​

Deprecation notices are communicated through the following channels:

  • This site: A dedicated deprecation notice page is published with full details, including affected functionality, migration steps, and the exact enforcement date.
  • Customer outreach: Your Aprimo Customer Success Manager may reach out directly if your tenant is known to be using affected functionality.