Flights

Create and store flight information for use with boarding passes. When creating boarding passes, you can reference a flight, automatically populating flight information on the pass. By storing and referencing flight information independently of your passes, you can update a single flight, automatically pushing an update to all passes referencing that flight.

Add flight to a pass group

Add a flight to a pass group. You can target the group to make changes to multiple flights.

Jump to examples ↓

POST /flights/project/{projectId}/{flightId}/passGroups

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want modify groups for. For External IDs, format the {flightId} as id/{flightExternalId}.

Request body:

Content-Type: application/json
OBJECT PROPERTIES
- passGroups array[string]
  An array of pass groups that you want to create and add a flight to. If a pass group (string) in the array already exists, it is ignored.

Responses

200
At least one pass group in the passGroups array was created.
Response body:
- Content-Type: application/json
  OBJECT PROPERTIES
  - flightId integer
    The Airship flight ID for the flight added to the pass group.
  - passGroups array[string]
    An array of pass groups that the flight was added to.
400
Missing or malformed input.
404
The flight or project cannot be found.

Examples

POST /v1/flights/project/12345/1234/passGroups HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightId" : 1234,
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

POST /v1/flights/project/id/67890/id/4567/passGroups HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightExternalId" : "4567",
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

Create flight

Create flights. See also Create flight with external ID.

Jump to examples ↓

POST /flights/project/{projectId}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project you want to create the flight in.

Request body:

Content-Type: application/json
Flight object
A complete flight request object.
The presence or absence of fields in the flight object may slightly affect the design of boarding passes. See Google Wallet Boarding Pass Design for more information on rendering logic for Google Wallet Boarding Passes.

Responses

200
A successful request returns the flightId and flightExternalId (if applicable) values, so you can reference the flight in later operations.
Response body:
- Content-Type: application/json
  Flight response
  A complete flight response, including identifiers to reference the flight and the fields defined within the flight.

Examples

POST /v1/flights/project/12345 HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups": ["sfo-pdx-20250319"],
  "fields": {
    "flightNumber": { "value": "815" },
    "airlineCode": { "value": "WN" },
    "airlineName": { "value": "Southwest Airlines" },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "25"
    },
    "boardingTime": { "value": "2025-03-19T20:30:00" },
    "departureTime": { "value": "2025-03-19T20:59" },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalTime": { "value": "2025-03-20T09:30:00" },
    "flightStatus": { "value": "scheduled" },
    "semantics" :{
          "airlineCode": "WN",
          "flightNumber": 2214,
          "originalBoardingDate": "2025-03-19T20:30:00-08:00",
          "originalDepartureDate": "2025-03-20T02:00:00-05:00",
          "originalArrivalDate": "2025-03-20T02:00:00-05:00",
          "currentBoardingDate": "2025-03-19T20:59:00-08:00",
          "currentDepartureDate": "2025-03-19T20:59:00-08:00",
          "currentArrivalDate": "2025-03-20T09:30:00-08:00",
          "departureAirportCode": "SFO",
          "departureCityName": "San Francisco",
          "departureLocationTimeZone": "America/Los_Angeles",
          "departureAirportLocation": {
               "latitude": 37.6191,
               "longitude": 122.3816
          },
         "departureGate": "25",
         "departureTerminal": "2",
         "destinationAirportCode": "PDX",
         "destinationCityName": "Portland",
         "destinationLocationTimeZone": "America/Los_Angeles",
         "destinationAirportLocation": {
              "latitude": 40.6446,
              "longitude": 73.7797
         },
         "destinationGate": "6",
         "destinationTerminal": "1"
   }
  }
}

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "projectId": 12345,
  "createdAt": "2025-03-05T09:12:32Z",
  "updatedAt": "2025-03-05T09:12:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "25"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2025-03-19T20:30:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2025-03-19T20:59:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2025-03-20T09:30:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    },
    "semantics" :{
          "airlineCode": "WN",
          "flightNumber": 2214,
          "originalBoardingDate": "2025-03-19T20:30:00-08:00",
          "originalDepartureDate": "2025-03-20T02:00:00-05:00",
          "originalArrivalDate": "2025-03-20T02:00:00-05:00",
          "currentBoardingDate": "2025-03-19T20:59:00-08:00",
          "currentDepartureDate": "2025-03-19T20:59:00-08:00",
          "currentArrivalDate": "2025-03-20T09:30:00-08:00",
          "departureAirportCode": "SFO",
          "departureCityName": "San Francisco",
          "departureLocationTimeZone": "America/Los_Angeles",
          "departureAirportLocation": {
               "latitude": 37.6191,
               "longitude": 122.3816
          },
         "departureGate": "25",
         "departureTerminal": "2",
         "destinationAirportCode": "PDX",
         "destinationCityName": "Portland",
         "destinationLocationTimeZone": "America/Los_Angeles",
         "destinationAirportLocation": {
              "latitude": 40.6446,
              "longitude": 73.7797
         },
         "destinationGate": "6",
         "destinationTerminal": "1"
   }
  }
}

Create flight with external ID

Create flights with external ID. See also Create flight.

Jump to examples ↓

POST /flights/project/id/{projectExternalId}/id/{flightExternalId}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectExternalId stringREQUIRED
The project you want to create the flight in.
flightExternalId stringREQUIRED
The external identifier you want to give to the flight.

Request body:

Content-Type: application/json
Flight object
A complete flight request object.
The presence or absence of fields in the flight object may slightly affect the design of boarding passes. See Google Wallet Boarding Pass Design for more information on rendering logic for Google Wallet Boarding Passes.

Responses

200
A successful request returns the flightId and flightExternalId (if applicable) values, so you can reference the flight in later operations.
Response body:
- Content-Type: application/json
  Flight response
  A complete flight response, including identifiers to reference the flight and the fields defined within the flight.

Examples

POST /v1/flights/project/id/project123ExtId/id/flight123ExtId HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": { "value": "815" },
    "airlineCode": { "value": "WN" },
    "airlineName": { "value": "Southwest Airlines" },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "25"
    },
    "boardingTime": { "value": "2018-07-30T08:35:00" },
    "departureTime": { "value": "2018-07-30T09:00:00" },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalTime": { "value": "2018-07-30T11:00:00" },
    "flightStatus": { "value": "scheduled" }
  }
}

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "flightExternalId": "flight123ExtId",
  "projectId": 12345,
  "projectExternalId": "project123ExtId",
  "createdAt": "2018-07-05T09:12:32Z",
  "updatedAt": "2018-07-05T09:12:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "25"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2018-07-30T08:35:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2018-07-30T09:00:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2018-07-30T11:00:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    }
  }
}

Delete flight

Deletes the specified flight.

Jump to examples ↓

DELETE /flights/project/{projectId}/{flightId}

Security:

httpBasic

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want to get, update, or delete. For External IDs, format the {flightId} as id/{flightExternalId}.

Responses

200
The flight was deleted.
Response body:
- Content-Type: application/json
  OBJECT PROPERTIES
  - ok boolean
    If true, the operation completed successfully.

Examples

DELETE /v1/flights/project/12345/1234 HTTP/1.1
Authorization: Basic <Base64 key>
Api-Revision: 1.2

DELETE /v1/flights/project/id/project123ExtId/id/flight123ExtId HTTP/1.1
Authorization: Basic <Base64 key>
Api-Revision: 1.2

HTTP/1.1 200 OK

Get flight

Returns information for a single flight.

Jump to examples ↓

GET /flights/project/{projectId}/{flightId}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want to get, update, or delete. For External IDs, format the {flightId} as id/{flightExternalId}.

Responses

200
A successful request returns the flightId and flightExternalId (if applicable) values, so you can reference the flight in later operations.
Response body:
- Content-Type: application/json
  Flight response
  A complete flight response, including identifiers to reference the flight and the fields defined within the flight.

Examples

GET /v1/flights/project/12345/1234 HTTP/1.1
Authorization: Basic <authorization string>

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "projectId": 12345,
  "createdAt": "2018-07-05T09:12:32Z",
  "updatedAt": "2018-07-05T09:12:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "21"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2025-03-19T20:30:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2025-03-20T02:00:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2025-03-20T02:00:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    },
    "semantics" :{
          "airlineCode": "WN",
          "flightNumber": 2214,
          "originalBoardingDate": "2025-03-19T20:30:00-08:00",
          "originalDepartureDate": "2025-03-20T02:00:00-05:00",
          "originalArrivalDate": "2025-03-20T02:00:00-05:00",
          "currentBoardingDate": "2025-03-19T20:59:00-08:00",
          "currentDepartureDate": "2025-03-19T20:59:00-08:00",
          "currentArrivalDate": "2025-03-20T09:30:00-08:00",
          "departureAirportCode": "SFO",
          "departureCityName": "San Francisco",
          "departureLocationTimeZone": "America/Los_Angeles",
          "departureAirportLocation": {
               "latitude": 37.6191,
               "longitude": 122.3816
          },
         "departureGate": "25",
         "departureTerminal": "2",
         "destinationAirportCode": "PDX",
         "destinationCityName": "Portland",
         "destinationLocationTimeZone": "America/Los_Angeles",
         "destinationAirportLocation": {
              "latitude": 40.6446,
              "longitude": 73.7797
         },
         "destinationGate": "6",
         "destinationTerminal": "1"
   }
  }
}

GET /v1/flights/project/id/project123ExtId/id/flight123ExtId HTTP/1.1
Authorization: Basic <authorization string>

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "flightExternalId": "flight123ExtId",
  "projectId": 12345,
  "projectExternalId": "project123ExtId",
  "createdAt": "2018-07-05T09:12:32Z",
  "updatedAt": "2018-07-05T09:12:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "21"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2018-07-30T09:20:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2018-07-30T09:45:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2018-07-30T11:45:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    }
  }
}

List pass groups for a flight

Returns a list of pass groups associated with a flight.

Jump to examples ↓

GET /flights/project/{projectId}/{flightId}/passGroups

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want modify groups for. For External IDs, format the {flightId} as id/{flightExternalId}.

Responses

200
Returns a list of pass groups that a flight is associated with.
Response body:
- Content-Type: application/json
  OBJECT PROPERTIES
  - flightId integer
    The ID of the flight in the request.
  - passGroups array[string]
    An array of the pass groups that the flight belongs to.
400
Missing fields or malformed input.
404
The flight or project cannot be found.

Examples

GET /v1/flights/project/12345/1234/passGroups HTTP/1.1
Authorization: Basic <authorization string>

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 

{
  "flightId" : 1234,
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

GET /v1/flights/project/id/67890/id/4567/passGroups HTTP/1.1
Authorization: Basic <authorization string>

HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8 

{
  "flightExternalId" : 4567,
  "passGroups" :["sfo-pdx-20180730", "pdx-yvr-20180730"]
}

Remove flight from pass group

Removes a flight from a pass group. The group specified in the path will no longer appear in the flight’s passGroups array, nor will you be able to make changes to the flight by targeting the pass group.

Jump to examples ↓

DELETE /flights/project/{projectId}/{flightId}/passGroups/{passGroup}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. Use either the Airship-generated project ID or the external ID. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want modify groups for. Use either the Airship-generated flight ID or the external ID for the flight. For External IDs, format the {flightId} as id/{flightExternalId}.
passGroup stringREQUIRED
The pass group you want to remove the flight from.

Responses

200
The flight was successfully removed from the pass group.
400
The project, flight, or pass group was not found.

Examples

DELETE /v1/flights/project/12345/1234/passGroups/sfo-pdx-20180730 HTTP/1.1
Authorization: Basic <authorization string>

DELETE /v1/flights/project/id/67890/id/4567/passGroups/sfo-pdx-20180730 HTTP/1.1
Authorization: Basic <authorization string>

Update flight

Update any of the keys provided in the fields object of a Flight Request. Provide only the fields you want to update; any fields that you omit from the payload remain unchanged.

Jump to examples ↓

PUT /flights/project/{projectId}/{flightId}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. For External IDs, format the {projectId} as id/{projectExternalId}.
flightId integerREQUIRED
The flight you want to get, update, or delete. For External IDs, format the {flightId} as id/{flightExternalId}.

Request body:

Content-Type: application/json
Flight object
A complete flight request object.
The presence or absence of fields in the flight object may slightly affect the design of boarding passes. See Google Wallet Boarding Pass Design for more information on rendering logic for Google Wallet Boarding Passes.

Responses

200
A successful request returns the complete, updated flight object and the flightId and flightExternalId (if applicable) values, so you can reference the updated flight in later operations.
Response body:
- Content-Type: application/json
  Flight response
  A complete flight response, including identifiers to reference the flight and the fields defined within the flight.

Examples

PUT /v1/flights/project/12345/1234 HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "departureGate": { "value": "21" },
    "boardingTime": { "value": "2018-07-30T09:20:00" },
    "departureTime": { "value": "2018-07-30T09:45:00" },
    "arrivalTime": { "value": "2018-07-30T11:45:00" }
  }
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "projectId": 12345,
  "createdAt": "2018-07-05T09:12:32Z",
  "updatedAt": "2018-07-05T09:15:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "21"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2018-07-30T09:20:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2018-07-30T09:45:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2018-07-30T11:45:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    }
  }
}

PUT /v1/flights/project/id/project123ExtId/id/flight123ExtId HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "departureGate": { "value": "21" },
    "boardingTime": { "value": "2018-07-30T09:20:00" },
    "departureTime": { "value": "2018-07-30T09:45:00" },
    "arrivalTime": { "value": "2018-07-30T11:45:00" }
  }
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "flightId": 1234,
  "flightExternalId": "flight123ExtId",
  "projectId": 12345,
  "projectExternalId": "project123ExtId",
  "createdAt": "2018-07-05T09:12:32Z",
  "updatedAt": "2018-07-05T09:15:32Z",
  "passGroups": ["sfo-pdx-20180730"],
  "fields": {
    "flightNumber": {
      "label": "Flight Number",
      "value": "815"
    },
    "airlineCode": {
      "label": "Airline Code",
      "value": "WN"
    },
    "airlineName": {
      "label": "Airline Name",
      "value": "Southwest Airlines"
    },
    "departureAirport": {
      "label": "San Francisco",
      "value": "SFO"
    },
    "departureGate": {
      "label": "Gate #",
      "value": "21"
    },
    "boardingTime": {
      "label": "Boarding Time",
      "value": "2018-07-30T09:20:00"
    },
    "departureTime": {
      "label": "Departure Time",
      "value": "2018-07-30T09:45:00"
    },
    "arrivalAirport": {
      "label": "Portland",
      "value": "PDX"
    },
    "arrivalGate": {
      "label": "Arrival Gate",
      "value": ""
    },
    "arrivalTime": {
      "label": "Arrival Time",
      "value": "2018-07-30T11:45:00"
    },
    "flightStatus": {
      "label": "Flight Status",
      "value": "scheduled"
    }
  }
}

Update flights in a pass group

Update all of the flights in a pass group. See also Update flights with external ID in a pass group.

Jump to examples ↓

PUT /flights/project/{projectId}/passGroups/{passGroup}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectId integerREQUIRED
The project that the flight belongs to. Use either the Airship-generated project ID or the external ID.
passGroup integerREQUIRED
The pass group that you want to modify.

Request body:

Update fields common to a group of flights.

Content-Type: application/json
OBJECT PROPERTIES
- fields object
  Provide only the keys that you want to update from fields object of an flight Request; any fields that you omit from the payload remain unchanged.

Responses

200
The update was successful.
Response body:
- Content-Type: application/json
  OBJECT PROPERTIES
  - flights array[object]
    Lists the flights updated as a part of this pass group.
  - groupName string
    The pass group that you updated in this request.
400
The request was malformed.
404
The project ID or pass group was not found.

Examples

PUT /v1/flights/project/12345/passGroups/sfo-pdx-20180730 HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "fields": {
    "departureTime": {
      "value": "2018-08-30T10:00:00"
    }
  }
}

HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8 

{
  "groupName" : "sfo-pdx-20180730", 
  "flights" : [
    {
      "flightId" : 123
    },
    {
      "flightId" : 456
    }
  ]
}

Update flights with external ID in a pass group

Update fields common to a group of flights. Provide only the keys that you want to update from fields object of an flight Request; any fields that you omit from the payload remain unchanged. See also Update flights in a pass group.

Jump to examples ↓

PUT /flights/project/id/{projectExternalId}/id/passGroups/{passGroup}

Request headers:

Api-Revision stringREQUIRED
The particular API revision you want to use. In general, this is 1.2.
Possible values: 1.2

Path parameters:

projectExternalId stringREQUIRED
The project that the flight belongs to.
passGroup stringREQUIRED
The pass group that you want to modify.

Request body:

Provide only the field(s) you want to update for all of the flights in the group.

Content-Type: application/json
OBJECT PROPERTIES
- fields object
  Provide only the keys that you want to update from fields object of an flight Request; any fields that you omit from the payload remain unchanged.

Responses

200
The update was successful.
Response body:
- Content-Type: application/json
  OBJECT PROPERTIES
  - flights array[object]
    Lists the flights updated as a part of this pass group.
  - groupName string
    The pass group that you updated in this request.
400
The request was malformed.
404
The project ID or pass group was not found.

Examples

PUT /v1/flights/project/id/project123ExtId/id/passGroups/sfo-pdx-20180730 HTTP/1.1
Authorization: Basic <authorization string>
Content-Type: application/json

{
  "fields": {
    "departureTime": {
      "value": "2018-08-30T10:00:00"
    }
  }
}

HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8 

{
  "groupName" : "sfo-pdx-20180730", 
  "flights" : [
    {
      "flightId" : 123
    },
    {
      "flightId" : 456
    }
  ]
}