The API Deprecation Notice
Announce an API deprecation to developers
announce an api deprecation to developersdev tools / apitool-agnosticproductapideprecationdeveloper-relationscommsintermediate
Entry PT-0156 · full textReceived
We are deprecating this API endpoint or feature: [WHAT IS BEING RETIRED, THE REPLACEMENT, THE MIGRATION EFFORT FOR DEVELOPERS, THE TIMELINE]. Write the deprecation notice developers respect: the date in the first line, what breaks and when, the migration path with effort estimated honestly in hours, why we are doing it in one true sentence, the support window, and the exact headers or warnings they will see along the way. No marketing language. Then write the 90-day, 30-day, and 7-day reminder versions, each shorter than the last.
Inputs needed
- #Endpoint/feature, replacement, migration effort, timeline
The receipts
What good output looks like
Date in line one; migration effort honest in hours; zero marketing spin; reminder cadence drafted; a developer would call this a good deprecation
The stream
Reading the room…