Documentation

Getting StartedLinkSitesAPI ReferenceWebhooksAPI Change ManagementBackwards Compatible ChangesChangelog

API Change Management

In order to continue adding functionality, we will regularly make improvements and changes to our API.

Backwards Compatible Changes

The following types of changes we consider to be backwards compatible:

  • Adding new API resources
  • Adding new optional request parameters to existing API methods, using sensible defaults if not present in requests.
  • Adding new fields to existing API responses
  • Changing the order of fields in existing API responses.
  • Changing the length or format of opaque strings, such as object IDs, error messages, and human-readable strings.

You should ensure your code is robust enough to gracefully handle these changes.