• Cheat sheets
  • Documentation
  • API reference
  • Product updates
  • Sign in
Kontent.ai Learn
  • Try Kontent.ai
  • Plan
  • Set up
  • Model
  • Develop
  • Create
Sync API
API Reference
    • About Sync API
    • Why use Sync API?
    • Authentication
    • Postman collection
    • SDKs
    • API limitations
    • Guidelines on handling changes
    • Filtering

Guidelines on handling changes

The state of the Sync API may change in the future. However, the majority of the changes won't be breaking changes.To create more robust scripts and integrations, we recommend you get familiar with the list of general changes to the API that aren't considered breaking. Make sure your app doesn't rely on a state that might change in the future. In general, the non-breaking changes include adding functionality or changes in the order of the returned data. The following are NOT breaking changes:
  • General:
    • Add a new endpoint.
    • Change the API behavior to fix a bug in the service.
    • Change the rate limitation.
    • Change error message text.
  • Responses:
    • Add a new property to JSON objects.
    • Change the order of JSON object properties.
    • Add a new type of change.
    • Add a new response header.
    • Add a body to a request that contained none.
  • Requests:
    • Add a new optional property to JSON objects.
    • Add a new optional request header.
    • Add a new optional query string parameter.
    • Add a new filtering operator.
    • Add an optional body to a request that contained none.
Copyright © 2025 Kontent.ai. All rights reserved.
  • Web
  • Privacy policy
  • Cookies policy
  • Consent settings
  • Security
  • GDPR