Changelog

This is the changelog of the Understory API.

All additions or changes to API endpoints, general usage updates, and behavior changes will be reflected below. Breaking changes will be high-lighted in line with our Breaking Changes policy and the affected APIs grace period will be noted.

See API Versioning to learn more.

2025-04-29

The Bookings API is moved to Alpha. This means the API is available for integration but changes might still occur. Read the API Versioning article for more details.

• POST /v1/bookings: A new optional request body field metadata is added to allow for custom key/value pairs of metadata to be attached on the booking for later reference.
• POST /v1/bookings: The endpoint now only returns the ID and status of a successfull booking operation.

2025-04-08

The Events API is now available in early preview. The specification can be inspected in API Reference: Event.

2025-04-07

The Experience API is now available in early preview. The specification can be inspected in API Reference: Experience.

2025-04-03

The Bookings API is now available in early preview. The specification can be inspected in API Reference: Booking.

2025-03-20

This release adds marketing consents to the API enabling marketing automation flows.

Read more about the API in the API Reference: Get marketing consents.