This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

API Change Announcements

The following sections provide information about changes to Toast APIs.

Backwards-compatible changes are released ad hoc and documented in our API change log. If a change is not backwards compatible with existing API versions, it is considered a breaking change and we provide a development window in which you can make code changes to accommodate the API update.

The following are examples of backwards-compatible changes:

  • New JSON value in existing API endpoint

  • New endpoint

  • New API

  • New webhook

  • Rate limit increases

The following are examples of breaking changes that will include a development window:

  • New validation in POST, PUT, or PATCH requests

  • Changes to the meaning of data in existing JSON values

  • Functionality deprecation

  • New enumerated values

  • Allowing null values in fields that were previously always populated

  • Rate limit reductions

Breaking changes and their associated development windows can be found on the Integration Update Schedule.