Automated Backwards Compatibility

Content Cloud has an experimental feature for automated backwards compatibility, allowing you to pass a specific date as a version indicator to the API. Based on the version, the content type definitions from that date will be used, and values will be filled in / converted where possible.

E.g., changing a field to become a list: int to int[] would typically result in a client error. With backwards compatibility enabled, we will return the first array of the list for outdated clients until you have a chance to update them.

This does not work for all kinds of conversions. E.g., if you change a string field to an integer, we will provide a numeric decimal string for old clients. If your clients expect a hex string, it won’t work as expected. If you aren’t sure which conversions are supported, please reach out to us. Custom conversions are not supported yet; if you are interested in this feature, please contact us.

By default, only API system changes are versioned, meaning if you pass 2025-05-04 as the version to the API instead of the default latest, we will expect the same parameters and return the same format as on 2025-05-04; this does not work for your custom data like content type definitions, though, as automated backwards compatibility is not enabled by default. If you are interested in trying this out, please reach out to our support team.

Note: The compatibility date is the given date minus one day to account for potentially breaking changes during the provided date itself.

E.g., if you want to query for the content model that was active on May 5, 2025, at 11:59:59.999pm, you have to query for version 2025-05-06.