PATCH Transfers by id, context, contextId

Overview

Update/Modify transfer on a booking by transfer ID

Request

PATCH /[context]/[contextId]/Transfers/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID
id
Integer
Mandatory 
ID of the transfer
flightDate
String
Mandatory 
Date (Optional for patch but required if either date or time is needed to be updated)
flightTime
String
Mandatory 
Time (Optional for patch but required if either date or time is needed to be updated)
flightNumber
String
Mandatory 
Any value (must have at least 1 non-whitespace character) - Optional for patch
customers
List<HrefWrapper>
Mandatory 
URIs of customers to book on the transfer that has already been added to booking
Existing customers on the transfer will not be affected – this only books new customers on the transfer. (Optional for patch)

Customers

Name
Type
Requirement
Description
href
String
Optional 
URI of the resource

Request Example

{
  "flightDate": "2024-12-21",
  "flightTime": "10:10",
  "flightNumber": "UA105",
  "customers": [
    {
      "href": "/bookings/5057124/customers/4945397"
    },
    {
      "href": "/bookings/5057124/customers/4945397"
    }
  ]
}

Response Information

Response Codes

HTTP status code
Description
200 OK
The resource was updated successfully
202 Accepted
The request was accepted
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
403 Forbidden
One or more parameters has already been set on the resource record and cannot be updated
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server