Travel Agency Email API Reference

POST

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/addemail

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {travelagencyID} send the identifier returned in TravelAgency/id in the Workbench Create and Workbench Retrieve responses.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Put	ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updateemail See the POST request above for variables and the base path.

DEL

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deleteemai/l{emailID}

For {emailID} send the identifier returned in TravelAgency/Email/id in the Workbench Create and Workbench Retrieve responses.

See the POST request above for other variables and the base path.

The Travel Agency Email API supports POST, PUT, and DEL requests to add, modify, or delete a travel agency email address to the booking A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. in the current workbench. All requests must be sent as part of a workbench session, either during the initial booking workflow or a post-commit Refers to the state of a booking after the booking is created, which happens after the initial booking workbench is commited and the reservation locator code issued. workbench for an existing booking, and followed by a workbench commit.

For adding only, you can instead use the Travel Agency Details API to add all travel agency details in a single request using one payload.

The reservation retrieve for a booking returns any travel agency details associated with that booking.

Use the Travel Agency requests only for travel agency contact details. Create and modify traveler details in the Add Traveler and Traveler Updatable Items requests.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Use the following request for the update operation. The delete request does not have a message body.

Note the different endpoints for each operation per above.

Show Request Body Table

Object	Description	Required/Optional
TravelAgencyQueryTravelAgencyEmailWrapper	Top level object.	Required
TravelAgencyQueryTravelAgencyEmail	Top level object.	Required
Email	Top level object for email address.	Required
value	String. Max length 128. Email address.	Required

Response

The response returns the travel agency identifier and the details sent in the request.

Show Response Body Table

Object	Description
TravelAgencyResponse	Top level object. Includes TravelAgency object.
TravelAgency	Corporate code value. Key value pair: id: System-assigned internal id for this travel agency. Must be sent in any subsequent update or delete request for the address added. This id is not associated with the internal id generated if a corporate ID is added for the same travel agency. The two ids are separate; the value returned here is used only in subsequent update or delete requests for this address.
Identifier	System-generated identifier for the travel agency; use this in subsequent update and delete request: authority: Source of information. value: Unique system-generated identifier In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..
Email	Id for the address sent in the add or update request. Key value pair: id: System-assigned internal id for this address. Must be sent in any subsequent update or delete request for this address.

Example Request

Use the following request to modify any part of a travel agency email address.

The delete response returns a No Content message.

Show Example add travel agency email request

{
 "TravelAgencyQueryTravelAgencyEmailWrapper": {
  "TravelAgencyQueryTravelAgencyEmail": {
   "Email": {
    "@type": "Email",
    "id": "email_1",
    "value": "sindar.singh@none.com"
   }
  }
 }
}

Example Response

The following response is returned for the update travel agency email request.

The delete response returns a 204 No Content message.

Show Example

{
 "TravelAgencyResponse": {
  "TravelAgency": {
   "@type": "TravelAgencyDetail",
   "id": "travelAgency_1",
   "Identifier": {
    "value": "328a3a99-dd30-486f-9653-37619bdbdbe5",
    "authority": "Travelport"
   },
   "Email": [
    {
     "id": "email_1"
    }
   ]
  }
 }
}