Update a Boarding pass

Pass updates are an important way to engage with your users after the pass is created. For example, by updating the Boarding Pass points on a users card as they redeem their points.

To update the way passes are displayed, such as when the logo changes, you only need to update or patch the Boarding Pass class or use the Google Pay and Wallet Console. Google propagates this information to every Boarding Pass object associated to the updated Boarding Pass class. This is the case for all fields defined at the Boarding Pass class level.

To update a single pass, such as when the Boarding Pass points balance changes, you need to update or patch a single Boarding Pass object. This is the case for all fields defined at the Boarding Pass object level.

Note:

Any update logic should begin with a GET request to retrieve the class or object. This ensures that the latest version of the class or object is used. Fields that you omit are cleared.

In general, it's much safer to use patch when you only supply data for the fields that you want to change. Fields that you omit aren't cleared. However, you should take extra care when you modify arrays. Patch requests that contain arrays also replace the existing array with the one you provide. You cannot modify, add, or delete items in an array in a piecemeal fashion.

Sometimes, you might not know when a change happens, or when to trigger an update or patch request. In cases like that, periodically schedule update or patch requests for each and every class and object. You can find all classes of a particular issuer account if you call the Boarding class list method. You can find all objects of a particular class if you call the Boarding object list method.

Data sources for flight updates

If the time given by class.localScheduledDepartureDateTime was in the past 24 hours or is in the next 48 hours, a flight status card appears to users. When this happens, Google Wallet can display data from either Google Flights or the information given in the Google Wallet pass. Which source is used depends on the following:

If class.localEstimatedOrActualDepartureDateTime is not provided, then Google Flights is used. In this case, any class.flightStatus you set is ignored.

For instance, if a flight is delayed, users see a card under the "Home" tab of the Google Wallet app that displays the new departure time. A similar delay card also surfaces to users under the "Passes" tab.
If you've provided the class.localEstimatedOrActualDepartureDateTime but not class.flightStatus, the provided time is used to determine if a flight is delayed. The flight status on the card is then surfaced to users based on the following logic:
- If class.localEstimatedOrActualDepartureDateTime is greater than class.localScheduledDepartureDateTime, show users a card with the flight listed as delayed.
- If class.localEstimatedOrActualDepartureDateTime is not greater than class.localScheduledDepartureDateTime, show users the card with the flight information but without any status message.

If you don't want to use Google Flights as a source of information about flights, be sure to provide the flightStatus, localScheduledDepartureDateTime, and localEstimatedOrActualDepartureDateTime of a FlightClass. Only your data is used on the card. Alternatively, if you use an ICAO carrier code instead of an IATA code in FlightClass, Google Flights is not used as a source of flight information.

When certain fields are changed, the user receives push notifications about the changes. For more details, see Receive flight update notifications.