Deprecation of the completion_requirements.fail indicator

Announced July 15, 2026 Due October 7, 2026 Pending

This is a deprecation notice - we are changing or removing support for the features described on this page on or after October 7, 2026. Please ensure to adjust your integrations accordingly before that date.

The boolean fail indicator inside the completion_requirements object on stop payloads is now deprecated and will be removed on 2026-10-07.

The replacement is the new failure_options object on the same stop payloads (for example on Show Booking): failure_options.outcomes.skip_recovery.allowed carries the same signal, and the object additionally indicates the availability of every other recovery outcome together with a localized reason when one is not available.

Until removal, completion_requirements.fail continues to work unchanged. Migrate by reading failure_options.outcomes.skip_recovery.allowed instead — note that failure_options renders on tour stops in failable states (approaching or arrived), so treat an absent object the same as fail: false.