Skip to main content
When we retire an endpoint, we make the transition as predictable as possible.

​
What Deprecation Means

A deprecated endpoint has been superseded by a newer one, usually because it was renamed or improved in a way that is not backwards compatible. Deprecated endpoints:
  • Keep working exactly as before until their end-of-life date. Your existing integration does not break when an endpoint is deprecated.
  • Are hidden from the API reference, which only documents the current endpoints.
  • Receive no new features. New functionality is only added to the current endpoints.

​
How Deprecations Are Announced

Every response from a deprecated endpoint, including error responses, carries the following headers: For example, a request to the deprecated /v1/avatar path returns:
We recommend logging a warning whenever your client receives a Deprecation header so you notice deprecations early. In addition, we notify affected customers directly ahead of any end-of-life date.

​
Migrating

To migrate, replace the deprecated path prefix in your requests with the one in the Link header and keep the rest of the path unchanged. For example, GET /v1/avatar/{id} becomes GET /v1/avatars/{id}. Successor endpoints are documented in the API reference. If you need help with a migration or more time to complete it, reach out to us at support@beyondpresence.ai.