A valid request URL is required to generate request examples{
"bid_id": 123,
"number": "<string>",
"code": "<string>",
"departure_airport": "YSSY",
"arrival_airport": "YMML",
"route": [
"YSSY",
"DCT",
"RIC",
"YMML"
],
"flight_level": "<string>",
"distance": 123,
"departure_time": "0930",
"arrival_time": "1145",
"flight_time": 1.42,
"days_of_week": [
3
],
"type": "P",
"aircraft": 123,
"notes": "<string>",
"aircraft_changeable": true,
"logo_light": "<string>",
"logo_dark": "<string>"
}{
"success": false,
"error": "Invalid Token"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}Change a bid's aircraft
Assigns a different aircraft to a bid before the flight is started. Persists the bid’s aircraft so /flights/start uses it. The chosen aircraft must be one returned by GET /flights/bookings/{bid}/aircraft. Rejected when the authenticated pilot has their own SimBrief OFP for the flight, once a PIREP is in progress, and for aircraft outside the flight’s eligible set.
A valid request URL is required to generate request examples{
"bid_id": 123,
"number": "<string>",
"code": "<string>",
"departure_airport": "YSSY",
"arrival_airport": "YMML",
"route": [
"YSSY",
"DCT",
"RIC",
"YMML"
],
"flight_level": "<string>",
"distance": 123,
"departure_time": "0930",
"arrival_time": "1145",
"flight_time": 1.42,
"days_of_week": [
3
],
"type": "P",
"aircraft": 123,
"notes": "<string>",
"aircraft_changeable": true,
"logo_light": "<string>",
"logo_dark": "<string>"
}{
"success": false,
"error": "Invalid Token"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}Authorizations
The pilot's API key, obtained via POST /pilot/login or your OAuth flow. Send as Authorization: Bearer <api_key> on every authenticated request.
Body
Response
Updated booking.
Unique bid ID. Used by /flights/start and /flights/unbook.
Flight number (no airline code).
Operating airline code.
Departure airport ID (ICAO).
"YSSY"
"YMML"
Route waypoints split on whitespace. Empty array if no route is filed.
["YSSY", "DCT", "RIC", "YMML"]
Cruise altitude as filed (free-form string, e.g. 360 or FL360).
Great-circle distance in the VA's configured local unit (typically nautical miles).
Scheduled departure, free-form per VA setting.
"0930"
"1145"
Scheduled flight time in decimal hours.
1.42
Days the flight operates (0 = Sunday). Empty if not configured.
0 <= x <= 6Coarse flight category derived from phpVMS's flight_type. P = passenger (scheduled/charter/extra/govt/other), C = cargo (ambulance/cargo/training/mail/military/positioning/special/general aviation/technical).
P, C Aircraft ID assigned to the bid: the SimBrief airframe if set, otherwise the bid's aircraft. Null when no aircraft is assigned, so the pilot must pick one (e.g. via /flights/change-aircraft) before starting.
Whether the pilot may switch the aircraft for this bid before starting. False when the authenticated pilot has their own SimBrief OFP for this flight. This is per-pilot, so another pilot's OFP does not lock it. Drives the client's dropdown-vs-text rendering.
Optional. URL of the operating airline's logo for light backgrounds. Shown at the start of the booking row in the client's light theme, up to 40px tall. Omit or send null to show no logo.
Optional. URL of the operating airline's logo for dark backgrounds. Used in the client's dark theme; falls back to logo_light when omitted or null.
Was this page helpful?