ZakCodeX brand logo
Developer workspace displaying source code

ZakCodeX API Versioning Policy

Versioned REST paths

ZakCodeX public REST endpoints use a major version in the URL, beginning with /api/v1/. Additive, backward-compatible fields may be introduced within a major version. Breaking request or response changes require a new major path such as /api/v2/.

Deprecation notice

ZakCodeX will normally announce a supported version’s deprecation at least 180 days before removal. Deprecated responses include the RFC 9745 Deprecation header and a Link with rel="deprecation" pointing to this policy. When a removal date is committed, responses will also include the RFC 8594 Sunset header.

Legacy unversioned routes

The original unversioned endpoints remain operational for compatibility but are deprecated. Migrate /api/phone-country to /api/v1/phone-country and /api/send-contact-submission to /api/v1/contact-submissions.

Rate limits and errors

API responses publish RateLimit-Policy and RateLimit structured fields, plus compatibility limit, remaining, and reset fields. A throttled request returns HTTP 429, a structured JSON error, and Retry-After. Consult the ZakCodeX OpenAPI specification for operation-level limits and schemas.