API changelog email template for developers
Developers read the email that tells them what breaks. This update puts the breaking change first with a deadline, shows the before and after in code, and keeps everything else short enough to scan.
- Example subject line
- API update: v3 endpoints, and v1 sunsets in 60 days
- Preview text
- Three new endpoints, one breaking change, and the migration guide you'll want bookmarked.
Use this template
Opens in the drag-and-drop editor, ready to edit.
Listed in
What's in this template
- Headline, short intro and the button: Read the full changelog
- Lime band for the breaking change, with a deadline
- Dark code diff showing the old and new header
- Button: Read the migration guide
- 3 new endpoints, each with its method, path and a note
- 2 image cards for smaller updates
- Support block with a command-line heading and a button: Join developer support
When to use it
Developers need dates in writing, so write one when an API version ships, a key format changes or an old endpoint is about to go away. Developer tools, payment APIs and data APIs fit, as does any product whose customers have code running against it.
Make it yours
- Put your real sunset date in the lime band, and say what happens to old requests.
- Replace the diff with your own before and after, kept to three lines.
- Swap the three endpoints for this release's changes, one line each.
