Start Eligibility Check
start_eligibility_checkStarts an upgrade eligibility check for a flight, cruise, or rail booking. Returns a secure page (and, where supported, an inline form) for the traveler to enter their booking reference and last name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| carrier | No | Airline/cruise/rail name or IATA code if known (e.g. 'Air Canada' or 'AC'). | |
| language | No | ISO 639-1 language for the page/offer (e.g. 'fr', 'es'). Defaults to 'en'. | |
| intentContext | No | The traveler's stated shopping intent — bound to the session and surfaced back so offers are presented against it. | |
| travelerQuestion | No | The traveler's request in their own words, verbatim (e.g. 'can I upgrade my Swiss flight to business?'). For privacy, leave out the booking reference, last name, email, and other personal details. Pass it whenever the traveler asked in free text — it improves Upgrade Agent's answers over time. |