---
title: HeyX public API versioning and deprecation policy
description: Stable major versions, compatible changes and deprecation signals for the HeyX public API.
canonical: https://heyx.app/versioning.md
---

# HeyX public API versioning and deprecation policy

The HeyX public API uses the package segment in every Connect procedure path as its major version. Current procedures use `publicapi.v1`, for example `/public-api/publicapi.v1.Contact/GetContact`.

## Compatible changes

HeyX may add new procedures, optional request fields, response fields and enum values within `publicapi.v1`. Integrations must ignore response fields they do not recognize and handle unknown enum values safely. Existing required request fields do not change incompatibly within a major version.

## Breaking changes

An incompatible contract is introduced under a new package and path such as `publicapi.v2`; it does not silently replace `publicapi.v1`. Migration documentation will identify replacements and material behavior changes.

## Deprecation and sunset signals

HeyX announces a public procedure deprecation in the developer documentation before removal. Deprecated HTTP responses use the `Deprecation` header and link to migration guidance. When a removal date is scheduled, responses also use the `Sunset` header with that date. Security or legal emergencies may require a shorter timeline, but ordinary breaking changes receive at least 90 days of notice.

See the [HeyX API documentation](https://docs.heyx.app/api-docs/), [generated API reference](https://docs.heyx.app/api-docs/reference/public-api/) and [OpenAPI specification](https://heyx.app/openapi.json) for the current contract.