Overview
As detailed in our Changes Policy, we from time to time are forced to introduce breaking changes as we evolve our API. Similarly, we might once in a while deprecate existing functionalities when newer functionalities serve a similar purpose in a better way. This page lists all upcoming deprecations and their potential breaking change impact details. The update date on this page indicates the release date where we announce the deprecation. It is immediately in effect, while the shutdown (sunset) date is the date where only the new API behaviour or model is available anymore.2025-11-13
Property name changes for GET template(s), GET sections
| Property | Description |
|---|---|
| Change | To align with our API conventions, we are changing from snake_case to camelCase property naming. Some properties are renamed: date_updated -> updatedAt, section_type -> type, sections_id -> section |
| Affected endpoints | List templates, List template sections, Get template |
| Impact | Both snake_case and camelCase or slightly renamed properties are being returned until the shutdown date. |
| Shutdown date | January 6th, 2026: We will not return snake_case properties anymore, please ensure you have adopted any necessary changes before that date. |
| Related Guide | Retrieving available templates |
Property name change for additionalInstructions
| Property | Description |
|---|---|
| Change | As we evolve the documents endpoint, we are renaming the additionalInstructions property to additionalInstructionsOverride for clarity that this field overrides any existing default. |
| Affected endpoints | POST documents from dynamic template |
| Impact | Until shutdown, both the now deprecated additionalInstructions as well as the new additionalInstructionsOverride are accepted in the request. |
| Shutdown date | January 6th, 2026: We will not accept additionalInstructions anymore, please ensure you have adopted any necessary changes before. |
| Related Guide | Advanced Document Generation |
Request schema change for POST documents template object
| Property | Description |
|---|---|
| Change | As we evolve the documents endpoint, we are changing the request schema when assembling sections into a template at the request. We are deprecating the sectionKeys property of type string[] in favour of the new sections property of type object[]. The new property requires at minimum a key with the sectionKey as value and can be optionally extended to customize several section fields with overrides. As previously and unchanged: the sorting of sections is implicit as set by the order of keys in the array. |
| Affected endpoints | POST documents from dynamic template |
| Impact | Until shutdown, both the now deprecated sectionKeys string[] as well as the new sections object[] can be passed in the request. |
| Shutdown date | January 6th, 2026: We will not accept sectionKeys anymore, please ensure you have adopted any necessary changes before. |
| Related Guide | Advanced Document Generation |