# API Deprecation Policy

As our platform evolves, we periodically update our APIs to improve performance, security, and functionality. This may involve **deprecating** older endpoints that are outdated, inefficient, or no longer align with our business goals.

Our deprecation process ensures a smooth transition for customers by providing advance notice, clear migration paths, and sufficient time to update integrations.

## Why We Deprecate

* Any of the following reasons can result in us deprecating endpoints:
* Replaced by a Newer Version – A newer endpoint provides better features, improved efficiency, or enhanced user experience.
* Performance & Scalability Issues – The existing endpoint may slow down due to high traffic or outdated architecture.
* Security Risks – The endpoint may not meet modern security standards or expose sensitive data.
* Business or Compliance Changes – Legal or business shifts (e.g., GDPR, CCPA) may require removing certain API functionalities.
* Low or No Usage – If an endpoint is rarely used, maintaining it may not be necessary.
* Architectural Changes – Our backend infrastructure may change, requiring adjustments to API structures.
* API Standardization & Naming Consistency – We may update endpoints to align with industry best practices and naming conventions.
* Breaking API Dependencies – The endpoint may rely on external services or technologies that are being discontinued.


## Deprecation Process

Our deprecation process follows a structured timeline to ensure minimal disruption:

### Advance Notice & Announcement

* Deprecated endpoints are marked in our API documentation.
* Customers receive notifications via email, dashboard alerts, and release notes.
* A clear migration path is provided to help users transition to an alternative API.


### Deprecation Warning Period

* The API remains functional but returns a warning message in the response header.
* Customers can still use the deprecated endpoint but are encouraged to migrate.


### Restricted Access Period

* Before final removal, we may rate-limit or restrict access to deprecated endpoints.
* Customers experiencing issues can contact support for assistance.


### Documenting Deprecation

* All deprecated endpoints will be clearly marked as deprecated in our API documentation.
* Deprecation details, including migration steps and removal timelines, will be added to our changelog.


### Endpoint removal

* After the deprecation timeline ends, the endpoint is removed from our platform.
* Calls to the endpoint will return a 410 Gone or 404 Not Found response.


## Stay Updated

Consult our [Changelog](/versionchange/changelog) page, keep a look out for relese notes, speak to your CSM or contact [support](https://support.firstup.io/hc/en-us) for help.