Simplified stop update routes

Announced August 13, 2024 Due March 11, 2026

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

We have added simplified routes for granular stop data editing endpoints.

Historically, to update a stop’s information you had to also supply the corresponding booking ID, for example at /api/hailing/bookings/:booking_id/stops/:stop_id/metadata. Due to the ongoing split between bookings and tours you would also in the future have needed to call different endpoints depending on whether it’s a tour or booking stop.

To simplify this, we have removed the booking and tour namespacing from endpoints related to editing stop data, linked below. All of the endpoints now follow the route schema /api/stops/:id/[endpoint].

patch /api/stops/{stop_id}/additional_information
Update Additional Information
patch /api/stops/{stop_id}/arrival_times
Update Arrival Times
patch /api/stops/{stop_id}/contact
Update Contact Details
put /api/stops/{stop_id}/content
Update Custom Content
post /api/stops/{stop_id}/complete
Complete stop
post /api/stops/{stop_id}/fail
Fail stop
patch /api/stops/{stop_id}/location
Update Location
put /api/stops/{stop_id}/metadata
Update Stop's Metadata
patch /api/stops/{stop_id}/metadata
Partially Update Stop's Metadata
patch /api/stops/{stop_id}/properties
Update Stop Properties
put /api/stops/{stop_id}/transition
Perform Stop Transition


The old routes remain supported for the time being but will be removed in the future.