API Changelog

Changes to the public Warmerly API (/api/v1/*), most recent first. This tracks the API and these docs — for product feature announcements, see the in-app changelog at app.warmerly.com.

2026-08-19

• Documented the Leads, Suppression, and Webhooks endpoints for the first time — these were live in the API but previously undocumented.
• Added this changelog and a shared Errors & Rate Limits reference page, consolidating error-shape and rate-limit details that were previously scattered across (or missing from) individual endpoint pages.
• Added an explicit statement of which routes are deliberately excluded from these docs — see What's not documented here on the overview page.
• No API behavior changed as part of this entry — this was a documentation-only pass (tracked as Octelis/warmerly#61).

Deprecation policy

Warmerly is a small, actively developed API, so this policy is intentionally simple:

• Breaking changes (removing a field, changing a field's type or meaning, changing required parameters) ship as a new endpoint or a new path rather than mutating an existing one in place. Existing integrations keep working unchanged.
• Deprecated endpoints get a minimum of 90 days' notice before removal, announced here in this changelog, before they stop working. Deprecated endpoints continue to function normally during the notice period.
• Additive changes (new optional fields, new endpoints, new optional query parameters) are not considered breaking and may ship without advance notice — always code defensively against unknown extra fields in a JSON response.
• Security fixes (e.g. tightening an input validator that was incorrectly permissive) are exempt from the notice period when a delay would leave a real vulnerability open.