Guides ยท Technology

API Deprecation Header Usage

Signal deprecations in responses

Deprecation headers (Deprecation, Sunset, Link) inform clients about end dates and docs; include clear dates, docs URLs, and keep responses consistent while versions are supported.

Set Headers

Use Deprecation/Sunset dates and Link to migration docs.

Be Consistent

Include on responses for affected endpoints/versions.

Monitor

Track client usage; follow up with key consumers.

Keep Exploring

Related Terms

One useful idea at a time

Get new explainers in your inbox

Occasional clear explanations. No daily noise.