---
title: "Updates passengers FOID on an order - not to be used generally, only supported on a select number of suppliers for specific purposes"
method: POST
path: "/updatepaxfoid/{orderId}/{orderKey}/{productId}"
tags: ["BookingFlow"]
---

# Updates passengers FOID on an order - not to be used generally, only supported on a select number of suppliers for specific purposes

`POST /updatepaxfoid/{orderId}/{orderKey}/{productId}`

## Request

- Base URL: `https://api.travelify.io`
- URL: `https://api.travelify.io/updatepaxfoid/{orderId}/{orderKey}/{productId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/travelify/apis/travelify-io-api/docs/updatepaxfoid/:orderId/:orderKey/:productId/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `orderId` integer, required
- `orderKey` string, required
- `productId` integer, required

## Request body

- UpdatePassengerCriteria: Passenger update criteria
  - `passengers` TravellerData[], required: Array of passengers to update
    - `type` 1 | 2 | 3, required: Enumerator defining main type of traveller:<br>1=Adult, 2=Child, 3=Infant
    - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required: Enumerator defining traveller name titles:<br>0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr
    - `firstname` string, required: Firstname of traveller
    - `middleNames` string, nullable: Optional middle names or initials of traveller
    - `surname` string, required: Surname of traveller
    - `dateOfBirth` string, date-time: Date of birth of traveller (YYYY-MM-DD)
    - `age` integer, nullable: DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip
    - `gender` 0 | 1 | 2: Enumerator defining gender:<br>0=Unspecified, 1=Male, 2=Female
    - `nationality` string, nullable: Traveller nationality
    - `foidType` 1 | 2 | 3: Enumerator defining forms of identification:<br>1=Passport, 2=NationalIDCard, 3=DrivingLicense
    - `foidNumber` string, nullable: Form of identification number
    - `foidStartDate` string, date-time, nullable: Form of identification start date (YYYY-MM-DD)
    - `foidExpiryDate` string, date-time, nullable: Form of identification expiry date (YYYY-MM-DD)
    - `foidIssuingCountry` string, nullable: Form of identification issuing country
    - `emailAddress` string, nullable: Optional traveller email address
    - `telephone` PhoneNumber: Phone number details
      - `type` 1 | 2 | 3 | 4: Enumerator defining phone types:<br>1=Generic, 2=Mobile, 3=Home, 4=Office
      - `countryPrefix` string, nullable: Country prefix (e.g. 44)
      - `number` string, nullable: Phone number
    - `extras` ExtraSelectionItem[], nullable: Array of optional extras for this passenger
      - `eid` string, required: Extra ID
      - `gid` string, nullable: Optional Extra Group ID (if in extra group)
      - `tid` integer, nullable: Optional Traveller ID (if related to a traveller)
      - `qty` integer, required: Quantity required
      - `participants` TravellerData[], nullable: Array of participants for the extras booking
    - `roomAllocIdx` integer, nullable: Optional room allocation index (for accommodation bookings, only supported by some suppliers)
  - `emailAddress` string, email, nullable: Contact email address
  - `telephone` PhoneNumber: Phone number details
    - `type` 1 | 2 | 3 | 4: Enumerator defining phone types:<br>1=Generic, 2=Mobile, 3=Home, 4=Office
    - `countryPrefix` string, nullable: Country prefix (e.g. 44)
    - `number` string, nullable: Phone number

## Response `200`

Success - Returns the status of the confirmation request.

- APIResponseData: Model defining the data API response.
  - `success` boolean: Indicator as to whether API request was successful.
  - `error` string, nullable: Returns an error if success is returned as false.
  - `data` unknown
  - `deposit` OrderDepositOptionDBO: Model for defining deposit option
    - `id` integer: Deposit identifier
    - `optionId` integer: Deposit option identifier
    - `initialAmount` number, double: Initial payment amount
    - `currency` string, nullable: Currency code
    - `breakdown` DepositBreakdown[], nullable: Breakdown
      - `num` integer: Installment number
      - `amount` number, double: Installment amount
      - `dueDate` string, date-time: Installment due date
      - `supplierDueDate` string, date-time, nullable: Optional supplier balance due date

## Other responses

- `400`: Bad request - check the response message for what information is missing or incorrect.
- `401`: Authentication error - check your authentication headers.
- `417`: Error response - check the response errors for more information.
- `500`: Error response - internal unrecoverable system error.

## Changes

- **2026-09-26** `5786ff0ca714`: 3 info
  - added the new optional request property `emailAddress`
  - added the new optional request property `passengers/items/telephone`
  - added the new optional request property `telephone`
- **2026-09-18** `47a9e887f446`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/travelify/apis/travelify-io-api/changes/updatepaxfoid/:orderId/:orderKey/:productId/post.md)

---

[API](https://skmtc.dev/travelify/apis/travelify-io-api.md) - [All operations](https://skmtc.dev/travelify/apis/travelify-io-api/llms.txt) - [OpenAPI document](https://skmtc.dev/travelify/apis/travelify-io-api/revisions/d8c23208674c?raw)