# Create event Create a draft event. Optionally pass newTraveler to create a new traveler and add them to the event. If the traveler already exists, the request fails — use the travellers field with the existing userId. Endpoint: POST /v2/events Version: v2 Security: Bearer ## Security: - `Bearer` (unknown) http bearer ## Request fields (application/json): - `name` (string, required) Name of the event - `description` (string) Description of the event - `documents` (array) Documents attached for an event - `documents.url` (string, required) S3 location of the document. Example: https://s3.amazonaws.com/bucket-name/folder-name/file-name - `documents.documentId` (string, required) Unique identifier of the document. Example: f49d00fe-1eda-4304-ba79-a980f565281d - `documents.documentMetadata` (object, required) Metadata related to document. - `documents.documentMetadata.documentType` (string, required) Document type. Enum: "BOARDING_PASS", "CONFIRMATION", "INVOICE", "VISA", "MISCELLANEOUS", "OTHERS", "TASK_PROCESSOR", "EVENT_COVER_IMAGE", "LOGO_IMAGE", "KNOWLEDGE_BASE", "AI_SKILL_FILE" - `documents.documentMetadata.entityType` (string, required) Entity type against which the document is to uploaded. Enum: "PNR", "COMPANY", "AIR_ITINERARY", "EVENT", "LOCATION_IMAGE", "AIR_COMMISSION_CONTRACT" - `documents.documentMetadata.entityId` (string, required) Entity Id for the given entity type. Example: 123124 - `documents.documentMetadata.entityMetadata` (object, required) Metadata for associated entity of document. - `documents.documentMetadata.entityMetadata.pnrMetadata` (object) Metadata when document is associated to pnr entity. - `documents.documentMetadata.entityMetadata.pnrMetadata.flightMetadata` (object) Flight metadata against which document is associated. - `documents.documentMetadata.entityMetadata.pnrMetadata.flightMetadata.flightId` (string) Unique identifier of the flight. Example: CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ - `documents.documentMetadata.entityMetadata.pnrMetadata.legMetadata` (object) Leg metadata against which document is associated. - `documents.documentMetadata.entityMetadata.pnrMetadata.legMetadata.legId` (string) Unique identifier of the leg. Example: CgNTRk8SA0RFThoKNTQ1NzI5ODcxMQ== - `documents.documentMetadata.entityMetadata.invoiceMetadata` (object) Metadata associated with an invoice document. - `documents.documentMetadata.entityMetadata.invoiceMetadata.invoiceNumber` (string, required) Example: SPOT-0001 - `documents.documentMetadata.entityMetadata.invoiceMetadata.invoiceType` (string) Enum: "SERVICE_FEE_INVOICE", "FARE_INVOICE", "GENERIC_INVOICE" - `documents.documentMetadata.entityMetadata.travelType` (string, required) Travel Type Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL" - `documents.documentMetadata.entityMetadata.eventMetadata` (object) Metadata when document is associated to an event. - `documents.documentMetadata.entityMetadata.eventMetadata.address` (object) Postal Address Details - `documents.documentMetadata.entityMetadata.eventMetadata.address.addressLines` (array, required) Address lines - `documents.documentMetadata.entityMetadata.eventMetadata.address.administrativeArea` (string) Code of administrative area. For example: DL for Delhi, India. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. Example: CA - `documents.documentMetadata.entityMetadata.eventMetadata.address.administrativeAreaName` (string) Name of administrative area. This is full name corresponding to administrativeArea. Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo. Example: California - `documents.documentMetadata.entityMetadata.eventMetadata.address.description` (string) Address description Example: San Francisco Home - `documents.documentMetadata.entityMetadata.eventMetadata.address.isDefault` (boolean) Whether this address is default address in case multiple addresses are specified. Example: true - `documents.documentMetadata.entityMetadata.eventMetadata.address.languageCode` (string) BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. Examples: "zh-Hant", "ja", "ja-Latn", "en". Example: en - `documents.documentMetadata.entityMetadata.eventMetadata.address.locality` (string) Generally refers to the city/town portion of the address. Example: San Francisco - `documents.documentMetadata.entityMetadata.eventMetadata.address.locationCode` (string) IATA 3-letter location code. See https://www.iata.org/en/services/codes. Example: LAX - `documents.documentMetadata.entityMetadata.eventMetadata.address.organization` (string) The name of the organization at the address. Example: Spotnana - `documents.documentMetadata.entityMetadata.eventMetadata.address.postalCode` (string) Postal code of the address. This is a required field when setting for a user/legal entity/company etc. Example: 94130 - `documents.documentMetadata.entityMetadata.eventMetadata.address.continentCode` (string) 2 letter continent code of the continent this address falls in. Example: AF - `documents.documentMetadata.entityMetadata.eventMetadata.address.recipients` (array) The recipient at the address. - `documents.documentMetadata.entityMetadata.eventMetadata.address.regionCode` (string, required) Region code of the country/region of the address. Example: US - `documents.documentMetadata.entityMetadata.eventMetadata.address.regionName` (string) Region name of the country/region of the address. Example: America - `documents.documentMetadata.entityMetadata.eventMetadata.address.revision` (integer) Example: 1 - `documents.documentMetadata.entityMetadata.eventMetadata.address.sortingCode` (string) Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). Example: Jamaica - `documents.documentMetadata.entityMetadata.eventMetadata.address.sublocality` (string) Sublocality of the address. This can be neighborhoods, boroughs, districts. - `documents.documentMetadata.entityMetadata.eventMetadata.address.timezone` (string) Time zone of the address. Example: America/Los_Angeles - `documents.documentMetadata.entityMetadata.eventMetadata.address.coordinates` (object) Latitude and Longitude for a Location - `documents.documentMetadata.entityMetadata.eventMetadata.address.coordinates.latitude` (number, required) Latitude of the Location Example: 77.1025 - `documents.documentMetadata.entityMetadata.eventMetadata.address.coordinates.longitude` (number, required) Longitude of the Location Example: 28.7041 - `documents.documentMetadata.name` (string, required) Document name. Example: BoardingPass.pdf - `startDateTime` (object) Local date and time in ISO 8601 format. - `startDateTime.iso8601` (string, required) Example: 2017-07-21T17:32 - `location` (object, required) Location for an event - `contacts` (array) Contacts for the event - `contacts.id` (string, required) - `bookingGuidelines` (array) A list of booking guideline for the event. - `bookingGuidelines.numGuestsAllowed` (integer) Number of guests allowed to be booked for this booking Example: 1 - `bookingGuidelines.airBookingGuideLine` (object) Air related guidelines - `bookingGuidelines.airBookingGuideLine.allowedAirports` (array) List of allowed airports for arrival of flight-in-event and departure of flight-out-event. - `bookingGuidelines.airBookingGuideLine.allowedAirports.airportCode` (string) 3-letter code of the airport. Example: WRA - `bookingGuidelines.airBookingGuideLine.allowedAirports.airportName` (string) Full name of the airport. Example: Warder Airport - `bookingGuidelines.airBookingGuideLine.allowedAirports.cityName` (string) Name of the city in which the airport is located (or is nearest to). Example: Werder - `bookingGuidelines.airBookingGuideLine.allowedAirports.countryName` (string) Name of the country in which the airport is located. Example: Ethiopia - `bookingGuidelines.airBookingGuideLine.allowedAirports.countryCode` (string) 2-letter IATA country code associated with the airport. Example: ET - `bookingGuidelines.airBookingGuideLine.allowedAirports.zoneName` (string) Name of the time zone associated with the airport. Example: Africa/Addis_Ababa - `bookingGuidelines.airBookingGuideLine.allowedAirports.stateCode` (string) 2-letter IATA code for the state in which the airport is located. Example: CA - `bookingGuidelines.airBookingGuideLine.allowedCityCodes` (array) List of allowed city codes for arrival of flight-in-event and departure of flight-out-event. If both allowedAirports and allowedCityCodes are provided, allowedCityCodes takes precedence. - `bookingGuidelines.airBookingGuideLine.arrivalBookingWindow` (object) Event booking window - `bookingGuidelines.airBookingGuideLine.allowedFlightGuidelines` (array) List of allowed flight guidelines for the event. - `bookingGuidelines.airBookingGuideLine.allowedFlightGuidelines.allowedFlightType` (string, required) The types of flight booking guidelines Enum: "ONE_WAY", "ROUND_TRIP", "MULTICITY" - `bookingGuidelines.airBookingGuideLine.allowedFlightGuidelines.numberOfLegs` (integer) The number of legs allowed for the flight booking. Example: 2 - `bookingGuidelines.hotelBookingGuideLine` (object) Hotel related guidelines - `bookingGuidelines.hotelBookingGuideLine.allowedHotels` (array) List of allowed Hotel details for the event - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.chainCode` (string) Chain code of the hotel. Example: RF - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.chainName` (string) Chain name of the hotel. Example: Red Roof Inns - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.email` (string) Email address of the hotel. Example: user@business.com - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.hotelId` (string) Hotel id. Example: 100094780 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.name` (string, required) Name of the hotel. Example: San Francisco Airport Red Roof - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone` (object) Properly formatted phone number. - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.countryCode` (integer) two digit country code Example: 91 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.countryCodeSource` (string) Enum: "UNSPECIFIED", "FROM_NUMBER_WITH_PLUS_SIGN", "FROM_NUMBER_WITH_IDD", "FROM_NUMBER_WITHOUT_PLUS_SIGN", "FROM_DEFAULT_COUNTRY" - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.extension` (string) phone number extension Example: 222 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.isoCountryCode` (string) ISO alpha-2 code Example: IN - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.italianLeadingZero` (boolean) Example: true - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.nationalNumber` (integer) Example: 8150 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.numberOfLeadingZeros` (integer) Example: 1 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.preferredDomesticCarrierCode` (string) Example: 7 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.rawInput` (string) Example: 77777 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.phone.type` (string) Enum: "UNKNOWN_TYPE", "MOBILE", "LANDLINE" - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.starRating` (number) Star rating of the hotel. Example: 3.5 - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.fax` (array) - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.masterChainCode` (string) Master chain code of the hotel. Example: EM - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.brandName` (string) Brand name of the hotel. Example: Marriott Hotel Brands - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.amenities` (array) - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.amenities.type` (string) Type of hotel amenity. Enum: "TWENTY_FOUR_HOUR_FRONT_DESK", "TWENTY_FOUR_HOUR_ROOM_SERVICE", "TWENTY_FOUR_HOUR_SECURITY", "ADJOINING_ROOMS", "AIR_CONDITIONING", "AIRLINE_DESK", "ATM_CASH_MACHINE", "BABY_SITTING", "BBQ_PICNIC_AREA", "BILINGUAL_STAFF", "BOOKSTORE", "BOUTIQUES_STORES", "BRAILED_ELEVATORS", "BUSINESS_LIBRARY", "CAR_RENTAL_DESK", "CASINO", "CHECK_CASHING_POLICY", "CHECK_IN_KIOSK", "COCKTAIL_LOUNGE", "COFFEE_SHOP", "COIN_OPERATED_LAUNDRY", "CONCIERGE_DESK", "CONCIERGE_FLOOR", "CONFERENCE_FACILITIES", "COURTYARD", "CURRENCY_EXCHANGE", "DESK_WITH_ELECTRICAL_OUTLET", "DOCTOR_ON_CALL", "DOOR_MAN", "DRIVING_RANGE", "DRUGSTORE_PHARMACY", "DUTY_FREE_SHOP", "ELEVATORS", "EXECUTIVE_FLOOR", "EXERCISE_GYM", "EXPRESS_CHECK_IN", "EXPRESS_CHECK_OUT", "FAMILY_PLAN", "FLORIST", "FOLIOS", "FREE_AIRPORT_SHUTTLE", "FREE_PARKING", "FREE_TRANSPORTATION", "GAME_ROOM", "GIFT_NEWS_STAND", "HAIRDRESSER_BARBER", "ACCESSIBLE_FACILITIES", "HEALTH_CLUB", "HEATED_POOL", "HOUSEKEEPING_DAILY", "HOUSEKEEPING_WEEKLY", "ICE_MACHINE", "INDOOR_PARKING", "INDOOR_POOL", "JACUZZI", "JOGGING_TRACK", "KENNELS", "LAUNDRY_VALET_SERVICE", "LIQUOR_STORE", "LIVE_ENTERTAINMENT", "MASSAGE_SERVICES", "NIGHTCLUB", "OFF_SITE_PARKING", "ON_SITE_PARKING", "OUTDOOR_PARKING", "OUTDOOR_POOL", "PACKAGE_PARCEL_SERVICES", "PARKING", "PHOTOCOPY_CENTER", "PLAYGROUND", "POOL", "POOLSIDE_SNACK_BAR", "PUBLIC_ADDRESS_SYSTEM", "RAMP_ACCESS", "RECREATIONAL_VEHICLE_PARKING", "RESTAURANT", "ROOM_SERVICE", "SAFE_DEPOSIT_BOX", "SAUNA", "SECURITY", "SHOE_SHINE_STAND", "SHOPPING_MALL", "SOLARIUM", "SPA", "SPORTS_BAR", "STEAM_BATH", "STORAGE_SPACE", "SUNDRY_CONVENIENCE_STORE", "TECHNICAL_CONCIERGE", "THEATRE_DESK", "TOUR_SIGHTSEEING_DESK", "TRANSLATION_SERVICES", "TRAVEL_AGENCY", "TRUCK_PARKING", "VALET_CLEANING", "DRY_CLEANING", "VALET_PARKING", "VENDING_MACHINES", "VIDEO_TAPES", "WAKEUP_SERVICE", "WHEELCHAIR_ACCESS", "WHIRLPOOL", "MULTILINGUAL_STAFF", "WEDDING_SERVICES", "BANQUET_FACILITIES", "BELL_STAFF_PORTER", "BEAUTY_SHOP_SALON", "COMPLIMENTARY_SELF_SERVICE_LAUNDRY", "DIRECT_DIAL_TELEPHONE", "FEMALE_TRAVELER_ROOM_FLOOR", "PHARMACY", "STABLES", "ONE_TWENTY_AC", "ONE_TWENTY_DC", "TWO_TWENTY_AC", "ACCESSIBLE_PARKING", "TWO_TWENTY_DC", "BARBEQUE_GRILLS", "WOMENS_CLOTHING", "MENS_CLOTHING", "CHILDRENS_CLOTHING", "SHOPS_AND_COMMERCIAL_SERVICES", "VIDEO_GAMES", "SPORTS_BAR_OPEN_FOR_LUNCH", "SPORTS_BAR_OPEN_FOR_DINNER", "ROOM_SERVICE_FULL_MENU", "ROOM_SERVICE_LIMITED_MENU", "ROOM_SERVICE_LIMITED_HOURS", "VALET_SAME_DAY_DRY_CLEANING", "BODY_SCRUB", "BODY_WRAP", "PUBLIC_AREA_AIR_CONDITIONED", "EFOLIO_AVAILABLE_TO_COMPANY", "INDIVIDUAL_EFOLIO_AVAILABLE", "VIDEO_REVIEW_BILLING", "BUTLER_SERVICE", "COMPLIMENTARY_IN_ROOM_COFFEE_OR_TEA", "COMPLIMENTARY_BUFFET_BREAKFAST", "COMPLIMENTARY_COCKTAILS", "COMPLIMENTARY_COFFEE_IN_LOBBY", "COMPLIMENTARY_CONTINENTAL_BREAKFAST", "COMPLIMENTARY_FULL_AMERICAN_BREAKFAST", "DINNER_DELIVERY_SERVICE_FROM_LOCAL_RESTAURANT", "COMPLIMENTARY_NEWSPAPER_DELIVERED_TO_ROOM", "COMPLIMENTARY_NEWSPAPER_IN_LOBBY", "COMPLIMENTARY_SHOESHINE", "EVENING_RECEPTION", "FRONT_DESK", "GROCERY_SHOPPING_SERVICE_AVAILABLE", "HALAL_FOOD_AVAILABLE", "KOSHER_FOOD_AVAILABLE", "LIMOUSINE_SERVICE", "MANAGERS_RECEPTION", "MEDICAL_FACILITIES_SERVICE", "TELEPHONE_JACK_ADAPTOR_AVAILABLE", "ALL_INCLUSIVE_MEAL_PLAN", "BUFFET_BREAKFAST", "COMMUNAL_BAR_AREA", "CONTINENTAL_BREAKFAST", "FULL_MEAL_PLAN", "FULL_AMERICAN_BREAKFAST", "MEAL_PLAN_AVAILABLE", "MODIFIED_AMERICAN_MEAL_PLAN", "FOOD_AND_BEVERAGE_OUTLETS", "LOUNGES_BARS", "BARBER_SHOP", "VIDEO_CHECKOUT", "ONSITE_LAUNDRY", "TWENTY_FOUR_HOUR_FOOD_AND_BEVERAGE_KIOSK", "CONCIERGE_LOUNGE", "PARKING_FEE_MANAGED_BY_HOTEL", "TRANSPORTATION", "BREAKFAST_SERVED_IN_RESTAURANT", "LUNCH_SERVED_IN_RESTAURANT", "DINNER_SERVED_IN_RESTAURANT", "FULL_SERVICE_HOUSEKEEPING", "LIMITED_SERVICE_HOUSEKEEPING", "HIGH_SPEED_INTERNET_ACCESS_FOR_LAPTOP_IN_PUBLIC_AREAS", "WIRELESS_INTERNET_CONNECTION_IN_PUBLIC_AREAS", "ADDITIONAL_SERVICES_AMENITIES_FACILITIES_ON_PROPERTY", "TRANSPORTATION_SERVICES_LOCAL_AREA", "TRANSPORTATION_SERVICES_LOCAL_OFFICE", "DVD_VIDEO_RENTAL", "PARKING_LOT", "PARKING_DECK", "STREET_SIDE_PARKING", "COCKTAIL_LOUNGE_WITH_ENTERTAINMENT", "COCKTAIL_LOUNGE_WITH_LIGHT_FARE", "MOTORCYCLE_PARKING", "PHONE_SERVICES", "BALLROOM", "BUS_PARKING", "CHILDRENS_PLAY_AREA", "CHILDRENS_NURSERY", "DISCO", "EARLY_CHECK_IN", "LOCKER_ROOM", "NON_SMOKING_ROOMS_GENERIC", "TRAIN_ACCESS", "AEROBICS_INSTRUCTION", "BAGGAGE_HOLD", "BICYCLE_RENTALS", "DIETICIAN", "LATE_CHECK_OUT_AVAILABLE", "PET_SITTING_SERVICES", "PRAYER_MATS", "SPORTS_TRAINER", "TURNDOWN_SERVICE", "DVDS_VIDEOS_CHILDREN", "BANK", "LOBBY_COFFEE_SERVICE", "BANKING_SERVICES", "STAIRWELLS", "PET_AMENITIES_AVAILABLE", "EXHIBITION_CONVENTION_FLOOR", "LONG_TERM_PARKING", "CHILDREN_NOT_ALLOWED", "CHILDREN_WELCOME", "COURTESY_CAR", "HOTEL_DOES_NOT_PROVIDE_PORNOGRAPHIC_FILMS_TV", "HOTSPOTS", "FREE_HIGH_SPEED_INTERNET_CONNECTION", "INTERNET_SERVICES", "PETS_ALLOWED", "GOURMET_HIGHLIGHTS", "CATERING_SERVICES", "COMPLIMENTARY_BREAKFAST", "BUSINESS_CENTER", "BUSINESS_SERVICES", "SECURED_PARKING", "RACQUETBALL", "SNOW_SPORTS", "TENNIS_COURT", "WATER_SPORTS", "CHILD_PROGRAMS", "GOLF", "HORSEBACK_RIDING", "OCEANFRONT", "BEACHFRONT", "HAIR_DRYER", "IRONING_BOARD", "HEATED_GUEST_ROOMS", "TOILET", "PARLOR", "VIDEO_GAME_PLAYER", "THALASSOTHERAPY", "PRIVATE_DINING_FOR_GROUPS", "HEARING_IMPAIRED_SERVICES", "CARRYOUT_BREAKFAST", "DELUXE_CONTINENTAL_BREAKFAST", "HOT_CONTINENTAL_BREAKFAST", "HOT_BREAKFAST", "PRIVATE_POOL", "CONNECTING_ROOMS", "DATA_PORT", "EXTERIOR_CORRIDORS", "GULF_VIEW", "ACCESSIBLE_ROOMS", "HIGH_SPEED_INTERNET_ACCESS", "INTERIOR_CORRIDORS", "HIGH_SPEED_WIRELESS", "KITCHENETTE", "PRIVATE_BATH_OR_SHOWER", "FIRE_SAFETY_COMPLIANT", "WELCOME_DRINK", "BOARDING_PASS_PRINT_OUT_AVAILABLE", "PRINTING_SERVICES_AVAILABLE", "ALL_PUBLIC_AREAS_NON_SMOKING", "MEETING_ROOMS", "MOVIES_IN_ROOM", "SECRETARIAL_SERVICE", "SNOW_SKIING", "WATER_SKIING", "FAX_SERVICE", "GREAT_ROOM", "LOBBY", "MULTIPLE_PHONE_LINES_BILLED_SEPARATELY", "UMBRELLAS", "GAS_STATION", "GROCERY_STORE", "TWENTY_FOUR_HOUR_COFFEE_SHOP", "AIRPORT_SHUTTLE_SERVICE", "LUGGAGE_SERVICE", "PIANO_BAR", "VIP_SECURITY", "COMPLIMENTARY_WIRELESS_INTERNET", "CONCIERGE_BREAKFAST", "SAME_GENDER_FLOOR", "CHILDREN_PROGRAMS", "BUILDING_MEETS_LOCAL_STATE_AND_COUNTRY_BUILDING_CODES", "INTERNET_BROWSER_ON_TV", "NEWSPAPER", "PARKING_CONTROLLED_ACCESS_GATES_TO_ENTER_PARKING_AREA", "HOTEL_SAFE_DEPOSIT_BOX_NOT_ROOM_SAFE_BOX", "STORAGE_SPACE_AVAILABLE_FEE", "TYPE_OF_ENTRANCES_TO_GUEST_ROOMS", "BEVERAGE_COCKTAIL", "CELL_PHONE_RENTAL", "COFFEE_TEA", "EARLY_CHECK_IN_GUARANTEE", "FOOD_AND_BEVERAGE_DISCOUNT", "LATE_CHECK_OUT_GUARANTEE", "ROOM_UPGRADE_CONFIRMED", "ROOM_UPGRADE_ON_AVAILABILITY", "SHUTTLE_TO_LOCAL_BUSINESSES", "SHUTTLE_TO_LOCAL_ATTRACTIONS", "SOCIAL_HOUR", "VIDEO_BILLING", "WELCOME_GIFT", "HYPOALLERGENIC_ROOMS", "ROOM_AIR_FILTRATION", "SMOKE_FREE_PROPERTY", "WATER_PURIFICATION_SYSTEM_IN_USE", "POOLSIDE_SERVICE", "CLOTHING_STORE", "ELECTRIC_CAR_CHARGING_STATIONS", "OFFICE_RENTAL", "PIANO", "INCOMING_FAX", "OUTGOING_FAX", "SEMI_PRIVATE_SPACE", "LOADING_DOCK", "BABY_KIT", "CHILDRENS_BREAKFAST", "CLOAKROOM_SERVICE", "COFFEE_LOUNGE", "EVENTS_TICKET_SERVICE", "LATE_CHECK_IN", "LIMITED_PARKING", "OUTDOOR_SUMMER_BAR_CAFE", "NO_PARKING_AVAILABLE", "BEER_GARDEN", "GARDEN_LOUNGE_BAR", "SUMMER_TERRACE", "WINTER_TERRACE", "ROOF_TERRACE", "BEACH_BAR", "HELICOPTER_SERVICE", "FERRY", "TAPAS_BAR", "CAFE_BAR", "SNACK_BAR", "GUESTROOM_WIRED_INTERNET", "GUESTROOM_WIRELESS_INTERNET", "FITNESS_CENTER", "ALCOHOLIC_BEVERAGES", "NON_ALCOHOLIC_BEVERAGES", "HEALTH_AND_BEAUTY_SERVICES", "LOCAL_CALLS", "MINIBAR", "REFRIGERATOR", "IN_ROOM_SAFE", "SMOKING_ROOMS_AVAILBLE", "MOUNTAIN_VIEW", "POOL_VIEW", "BEACH_VIEW", "OCEAN_VIEW", "ROOMS_WITH_BALCONY", "FAMILY_ROOM", "CRIB_CHARGE", "ROLLAWAY_ADULT", "FREE_WIFI_IN_MEETING_ROOMS", "ECO_FRIENDLY", "EXTRA_PERSON", "STAY_SAFE", "ENHANCED_HYGIENE_CLEANLINESS_PROTOCOLS" - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.amenities.additionalInfo` (string) Amenity description Example: Complimentary in-room coffee or tea - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.amenities.complimentary` (boolean) Is Amenity complimentary Example: true - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.additionalAmenities` (array) List of amenities provided by the supplier. Example: ["Room service","Wifi"] - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.imageSets` (array) - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.imageSets.category` (string, required) Category of image such as exterior, spa, etc. Enum: "UNKNOWN_CATEGORY", "EXTERIOR_VIEW", "LOBBY_VIEW", "POOL_VIEW", "RESTAURANT", "HEALTH_CLUB", "GUEST_ROOM", "SUITE", "MEETING_ROOM", "BALLROOM", "GOLF_COURSE", "BEACH", "SPA", "BAR_OR_LOUNGE", "RECREATIONAL_FACILITY", "LOGO", "BASICS", "MAP", "PROMOTIONAL", "HOT_NEWS", "MISCELLANEOUS", "GUEST_ROOM_AMENITY", "PROPERTY_AMENITY", "BUSINESS_CENTER" - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.imageSets.imageGroup` (object, required) Contains different sizes of the same image. - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.imageSets.imageGroup.caption` (string) Caption for the image. Example: Exterior - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.imageSets.imageGroup.images` (array, required) List of images. - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.descriptions` (array) - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.descriptions.type` (string) Hotel description type Enum: "GENERAL", "ALERTS", "DINING", "FACILITIES", "RECREATION", "SERVICES", "ATTRACTIONS", "CANCELLATION_POLICY", "DEPOSIT_POLICY", "DIRECTIONS", "POLICIES", "SAFETY", "TRANSPORTATION" - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.descriptions.value` (string) Hotel description value - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.thirdPartyHotelCodes` (array) - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.thirdPartyHotelCodes.hotelCode` (string, required) Third party hotel code. - `bookingGuidelines.hotelBookingGuideLine.allowedHotels.thirdPartyHotelCodes.hotelCodeType` (string, required) Type of the third party. Enum: "SABRE_CSL", "SABRE_TN", "EXPEDIA_RAPID", "MARRIOTT", "GIATA", "BCD", "AMADEUS_GDS", "BOOKING_COM", "PREMIER_INN", "HOTEL_HUB", "TRAVELODGE" - `bookingGuidelines.hotelBookingGuideLine.paymentGuidelines` (object) Hotel booking payment guidelines - `bookingGuidelines.carBookingGuideLine` (object) Car related guidelines - `bookingGuidelines.carBookingGuideLine.paymentGuidelines` (object) Car booking payment guidelines - `bookingGuidelines.carBookingGuideLine.paymentGuidelines.allowedPaymentVendors` (array) List of allowed car vendors for the event - `bookingGuidelines.carBookingGuideLine.paymentGuidelines.allowedPaymentVendors.vendorId` (string, required) ID of the vendor. - `bookingGuidelines.carBookingGuideLine.paymentGuidelines.allowedPaymentVendors.vendorName` (string, required) Name of the vendor. - `bookingGuidelines.carBookingGuideLine.paymentGuidelines.onlyVendorBooking` (boolean) Whether only Vendor bookings are allowed for the event. Example: true - `bookingGuidelines.railBookingGuideLine` (object) Rail related guidelines - `allowedBookingTypes` (array) Allowed booking types for the event group - `externalId` (string) External Id for the event Example: qwert123 - `eventCustomFieldResponses` (array) List of custom field responses for the event. - `eventCustomFieldResponses.customFieldId` (string, required) The unique identifier for the custom field. Example: f49d00fe-1eda-4304-ba79-a980f565281d - `eventCustomFieldResponses.responseItems` (array) Responses selected by the event coordinator. - `eventCustomFieldResponses.responseItems.response` (string, required) The response of the custom field. It can be a text input from the user or a custom field code if the input is from a radio button or checkbox. Example: Leisure travel - `eventCustomFieldResponses.responseItems.additionalInput` (string) This contains additional input to the above response. It will only be used for checkbox with percentage and will contain the percentage value. Example: 20 - `eventCustomFieldResponses.travelerAccess` (string, required) Traveler access for a custom field Enum: "HIDDEN", "READ_ACCESS", "WRITE_ACCESS" - `eventCustomFieldV3Responses` (array) List of custom field responses for an event. - `eventCustomFieldV3Responses.fieldId` (string, required) Custom field id - `eventCustomFieldV3Responses.fieldName` (string) Name of the custom field - `eventCustomFieldV3Responses.armId` (string, required) Arm id which is applicable - `eventCustomFieldV3Responses.readOnly` (boolean) Indicates whether the user can change the pre-selected options. Example: true - `eventCustomFieldV3Responses.hidden` (boolean) Whether this code will be hidden to the user. Example: true - `eventCustomFieldV3Responses.selectedOptions` (array, required) The list of options that are selected by user or auto populated. - `eventCustomFieldV3Responses.selectedOptions.name` (string, required) Value of the selection - `eventCustomFieldV3Responses.selectedOptions.translatedName` (string) Translated value of the selection - `eventCustomFieldV3Responses.selectedOptions.description` (string) Description of the selection - `eventCustomFieldV3Responses.selectedOptions.translatedDescription` (string) Translated description of the selection - `eventCustomFieldV3Responses.selectedOptions.additionalUserInput` (string) Additional user input - `eventCustomFieldV3Responses.selectedOptions.additionalInfos` (array) Actual values of the additional infos - `eventCustomFieldV3Responses.selectedOptions.additionalInfoConfigs` (array) Additional info configs for the selected option - `eventCustomFieldV3Responses.selectedOptions.additionalInfoConfigs.type` (string, required) Enum: "VARIABLE", "EXPRESSION" - `eventCustomFieldV3Responses.selectedOptions.additionalInfoConfigs.name` (string, required) Name of the variable. Enum: "PUBLISHED_FARE", "LLF", "ADD_COLLECT_AMOUNT", "SELECTED_FARE", "SPLIT_PAYMENT_FARE" - `eventCustomFieldV3Responses.selectedOptions.additionalInfoConfigs.formatExpression` (string, required) The expression must be of format : ` ${expression} `.The expression can consist of a combination of variables and mathematical operations. Variable names must be same as VariableName Enum. To define mathematical operations, the operation name should follow the format `math.(arg1, arg2)`. Both `arg1` and `arg2` can be variables or constants. The supported math operations (math_op) include: `add, mul, div, sub, min, and max`. All keywords, such as `, math, and var` must be written in lowercase. Example: Result: ${math.mul(LLF,5)} ${ADD_COLLECT_AMOUNT} - `eventCustomFieldV3Responses.selectedOptions.additionalInfoConfigs.variables` (array) Reference names of the variables present in the expression. - `parentEventId` (string) Optional parent event's id. Example: 56789012 - `companyId` (object) Company ID - `companyId.id` (string, required) Example: f49d00fe-1eda-4304-ba79-a980f565281d - `bookingStyle` (string) The booking style for the event's participants. Enum: "SELF_SERVE", "AGENT_MANAGED" - `referenceUsers` (array) Event group reference user ids - `travelerTypes` (array) Allowed traveler types for the event - `policyId` (string) Policy associated with the event. Example: f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b - `travellers` (array) Travellers associated with the event - `type` (string) Type of an event Enum: "GENERIC", "PROGRAM", "PROGRAM_SESSION", "PROGRAM_TRIP" - `allowTravelersPolicy` (string) Apply travelers policy when it is less restrictive. Enum: "ALLOWED", "NOT_ALLOWED" - `emailPreferences` (object) Email communication preferences based on bucket types. - `emailPreferences.bucketTypes` (array, required) List of email bucket types. - `emailPreferences.isEnabled` (boolean) Indicates whether emails are disabled. - `emailPreferences.toEmails` (array) List of email address to be included in emails. - `emailPreferences.ccEmails` (array) List of email address to be cc-ed in emails. - `emailPreferences.bccEmails` (array) List of email address to be bcc-ed in emails. - `internalNotes` (string) Internal notes of the event Example: Use travelers default as payment method. - `allowTravelersToRsvp` (string) Allow travelers to rsvp for the event Enum: "ALLOWED", "NOT_ALLOWED" - `tripOverrides` (object) Trip overrides for the event - `tripOverrides.legalEntity` (object, required) Legal entity override for the event - `tripOverrides.legalEntity.behavior` (string, required) Override behavior for the trip overrides Enum: "OVERRIDE_ALLOWED", "OVERRIDE_NOT_ALLOWED", "OVERRIDE_MANDATORY" - `tripOverrides.legalEntity.legalEntityRef` (object) Reference of an entity - `tripOverrides.legalEntity.legalEntityRef.id` (string, required) Example: b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3 - `tripOverrides.legalEntity.legalEntityRef.name` (string) Example: Name - `tripOverrides.costCenter` (object, required) Cost center override for the event - `tripOverrides.department` (object, required) Department override for the event - `tripOverrides.userAttributes` (array, required) List of company specified attribute overrides - `tripOverrides.userAttributes.attribute` (object, required) Company specified user arbitrary attribute. - `tripOverrides.userAttributes.attribute.fixedColumnName` (string, required) Example: contingentType - `tripOverrides.userAttributes.attribute.value` (string) Example: FSTV - `tripOverrides.rateCodeOverrides` (array) List of rate codes to be overridden for a trip - `tripOverrides.rateCodeOverrides.supplier` (string) Supplier type like Sabre, TravelFusion etc. Enum: "SABRE", "AMADEUS", "TRAVEL_FUSION", "FARELOGIX_NDC", "ATPCO_NDC", "TRAINLINE", "AVIA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "NDC", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE", "ENTERPRISE", "HYATT", "HILTON", "NATIONAL", "ALAMO", "HERTZ", "DOLLAR", "THRIFTY", "FIREFLY", "EUROSTAR", "AVIS", "BUDGET", "AMADEUS_NDC", "SIXT" - `tripOverrides.rateCodeOverrides.rateCodeIds` (array) List of rate code ids - `tripContacts` (array) Trip contacts for the event. These are passed through to created trips. - `tripContacts.label` (string, required) Label for the contact Example: Coordinator - `tripContacts.name` (string, required) Name of the contact Example: Himani Jain - `tripContacts.email` (string) Email of the contact Example: himani@spotnana.com - `tripContacts.isPrimary` (boolean) Whether the contact is primary or not Example: true - `tripContacts.restrictVisibility` (boolean) Whether to restrict visibility of the contact to only agents and admins Example: true - `inheritedCustomFieldIds` (array) List of custom field IDs that were inherited from parent - `inviteEmailConfig` (object) Configuration for event invite/reminder emails - `inviteEmailConfig.emailExcludeCoordinatorInfo` (boolean) Whether to exclude coordinator information in emails sent to travelers. Example: true - `enableRegisterLink` (boolean) Whether the open registration link is enabled for this event. Example: true - `useHiddenTemplate` (boolean) When true, the backend resolves the active hidden template for the company and uses it as the parent event. Mutually exclusive with parentEventId. - `newTraveler` (object) Traveler details. - `newTraveler.personalInfo` (object) User details. - `newTraveler.personalInfo.addresses` (array) - `newTraveler.personalInfo.dob` (object) Date in ISO 8601 standard. - `newTraveler.personalInfo.dob.iso8601` (string, required) Example: 2017-07-21 - `newTraveler.personalInfo.email` (string) Example: example@email.com - `newTraveler.personalInfo.emergencyContactInfo` (object) Emergency contact information. - `newTraveler.personalInfo.emergencyContactInfo.designation` (string) Example: MANAGER - `newTraveler.personalInfo.emergencyContactInfo.email` (string, required) Example: emergency-contact@email.com - `newTraveler.personalInfo.emergencyContactInfo.name` (object) Full name containing first, middle, last (family) names, and suffix. - `newTraveler.personalInfo.emergencyContactInfo.name.family1` (string, required) Last (family) name. Example: Gandas - `newTraveler.personalInfo.emergencyContactInfo.name.family2` (string) Example: FamilyTwo - `newTraveler.personalInfo.emergencyContactInfo.name.given` (string, required) First (given) name. Example: Vichitr - `newTraveler.personalInfo.emergencyContactInfo.name.middle` (string) Middle name. Example: Kumar - `newTraveler.personalInfo.emergencyContactInfo.name.suffix` (string) Suffix for name Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD" - `newTraveler.personalInfo.emergencyContactInfo.name.preferred` (string) Informal preferred name added by traveler. This is not used on any PNR or tickets Example: Don - `newTraveler.personalInfo.emergencyContactInfo.userOrgId` (object) User and user's organization information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationAgencyId` (object) Agency id for the organization. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationAgencyId.id` (string, required) - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationId` (object, required) Organization id for traveler. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationId.id` (string, required) - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo` (object) TMC config information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.primaryServiceProviderTmc` (object, required) Primary service provider TMC info - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.secondaryServiceProviderTmcs` (array) Secondary service provider TMCs for the TMC. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo` (object) TMC related basic information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.contractingTmc` (object, required) Basic information about a company. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.contractingTmc.name` (string) - `newTraveler.personalInfo.gender` (string) Enum: "MALE", "FEMALE", "UNSPECIFIED", "UNDISCLOSED", "GENDER_REDACTED" - `newTraveler.personalInfo.identityDocs` (array) List of user identity documents. Example: [{"passport":{"docId":"PASSPORTID","expiryDate":{"iso8601":"2017-07-21"},"issueCountry":"IN","issuedDate":{"iso8601":"2017-07-21"},"nationalityCountry":"IN","type":"REGULAR"}},{"ktn":{"number":"123456… - `newTraveler.personalInfo.identityDocs.passport` (object) Passport details. - `newTraveler.personalInfo.identityDocs.passport.docId` (string, required) Example: PassportID - `newTraveler.personalInfo.identityDocs.passport.issueCountry` (string, required) Example: IN - `newTraveler.personalInfo.identityDocs.passport.nationalityCountry` (string, required) Example: IN - `newTraveler.personalInfo.identityDocs.passport.type` (string) Enum: "UNKNOWN", "REGULAR" - `newTraveler.personalInfo.identityDocs.immigrationDoc` (object) Immigration document details. - `newTraveler.personalInfo.identityDocs.immigrationDoc.authorizedStayDuration` (object) Represents a duration of time with specific units of time. - `newTraveler.personalInfo.identityDocs.immigrationDoc.authorizedStayDuration.iso8601` (string) Durations define the amount of intervening time in a time interval and are represented by the format P[n]Y[n]M[n]DT[n]H[n]M[n]S. The [n] is replaced by the value for each of the date and time elements that follow the [n]. Leading zeros are not required. The capital letters P, Y, M, W, D, T, H, M, and S are designators for each of the date and time elements and are not replaced. P is the duration designator (for period) placed at the start of the duration representation. Y is the year designator. M is the month designator. W is the week designator. D is the day designator. T is the time designator. H is the hour designator. M is the minute designator. S is the second designator and can include decimal digits with arbitrary precision. Example: PT19H55M - `newTraveler.personalInfo.identityDocs.immigrationDoc.docId` (string, required) The ID of the immigration document. Example: ImmigrationDocumentID - `newTraveler.personalInfo.identityDocs.immigrationDoc.issueCountry` (string, required) The country that issued the immigration document. Example: IN - `newTraveler.personalInfo.identityDocs.immigrationDoc.nationalityCountry` (string) Example: IN - `newTraveler.personalInfo.identityDocs.immigrationDoc.type` (string) Enum: "UNKNOWN", "VISA" - `newTraveler.personalInfo.identityDocs.redress` (object) Redress details - `newTraveler.personalInfo.identityDocs.redress.number` (string, required) Example: 12345 - `newTraveler.personalInfo.identityDocs.redress.issueCountry` (string, required) Example: US - `newTraveler.personalInfo.identityDocs.ktn` (object) Information about the Known Traveler Number (KTN). - `newTraveler.personalInfo.identityDocs.ktn.number` (string, required) Example: 12345 - `newTraveler.personalInfo.identityDocs.ktn.issueCountry` (string, required) Example: US - `newTraveler.personalInfo.identityDocs.nationalDoc` (object) National Document Id details. - `newTraveler.personalInfo.identityDocs.nationalDoc.docId` (string, required) Unique id identifying the national document. Example: NationalDocId - `newTraveler.personalInfo.identityDocs.nationalDoc.issueCountry` (string, required) IS0 2 letter country code of the country issuing this id. Example: IN - `newTraveler.personalInfo.identityDocs.nationalDoc.type` (string) Enum: "DNI", "NIE", "CPF", "MTP", "CIN", "NID" - `newTraveler.personalInfo.phoneNumbers` (array) - `newTraveler.personalInfo.nationality` (string) Nationality of user Example: Indian - `newTraveler.personalInfo.title` (string) Enum: "TITLE_UNKNOWN", "MR", "MS", "MRS", "MX", "MASTER", "MISS", "DR", "PROFESSOR", "CAPTAIN", "REVEREND", "HONOURABLE", "SIR", "LADY", "AMBASSADOR", "LORD", "BRIGADIER", "SENATOR", "DAME", "JUSTICE", "UK", "TITLE_REDACTED" - `newTraveler.personalInfo.preferredLanguage` (string) Language preferred by user. Example: en-US - `newTraveler.personalInfo.preferredPronoun` (string) Enum: "SHE_HER_HERS", "HE_HIM_HIS", "THEY_THEM_THEIRS" - `newTraveler.personalInfo.emergencyContact` (object) Emergency contact information. - `newTraveler.personalInfo.emergencyContact.name` (string, required) Full name of contact. Example: John Smith - `newTraveler.personalInfo.emergencyContact.email` (string) Email address of contact. Example: emergency-contact@email.com - `newTraveler.personalInfo.emergencyContact.designation` (string) Job title of contact. Example: MANAGER - `newTraveler.personalInfo.emergencyContact.relation` (string) Relation of contact to user. Enum: "RELATION_UNKNOWN", "SPOUSE", "PARENT", "SIBLING", "CHILD", "FRIEND", "RELATIVE", "COLLEAGUE", "OTHER" - `newTraveler.personalInfo.emergencyContact.phoneNumbers` (array, required) Phone numbers of contact. - `newTraveler.personalInfo.emergencyContact.preferredLanguage` (string) Language preferred by user. Example: en-US - `newTraveler.businessInfo` (object) User business information. - `newTraveler.businessInfo.designation` (string) Example: MANAGER - `newTraveler.businessInfo.email` (string) Example: user@business.com - `newTraveler.businessInfo.employeeId` (string) Unique employee id. Can use email if a company don't use employee ids. Example: 101 - `newTraveler.businessInfo.phoneNumbers` (array) - `newTraveler.businessInfo.countryCode` (string) alpha-2 or alpha-3 ISO country code. Example: USA - `newTraveler.businessInfo.workerType` (string) The type of worker. Enum: "EMPLOYEE", "CONTINGENT", "SEASONAL", "INTERN", "GUEST" - `newTraveler.businessInfo.accountingCode` (string) Code used for accounting. Example: 123 - `newTraveler.businessInfo.companySpecifiedAttributes` (array) - `newTraveler.businessInfo.companySpecifiedAttributes.fixedColumnName` (string, required) Example: contingentType - `newTraveler.businessInfo.companySpecifiedAttributes.value` (string, required) Example: FSTV - `newTraveler.businessInfo.designatedApproverRefs` (array) A list of references for designated approvers. - `newTraveler.businessInfo.authorizerEmail` (string) Email address to be used as approval authorizer, when a manager is not present. Example: example@email.com - `newTraveler.relativeOf` (object) Link to primary traveler - `newTraveler.relativeOf.relation` (string) Enum: "SPOUSE", "CHILD", "FRIEND", "PARENT", "OTHER" - `newTraveler.billingCurrency` (string) Preferred billing currency of the user Example: INR - `newTraveler.tier` (string) Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Display names for other tiers are driven by the company tier configuration. Enum: "BASIC", "SEAT1A", "TIER_2", "TIER_3", "TIER_4", "TIER_5", "TIER_6", "TIER_7", "TIER_8", "TIER_9", "TIER_10", "TIER_11", "TIER_12", "TIER_13", "TIER_14", "TIER_15", "TIER_16", "TIER_17", "TIER_18", "TIER_19", "TIER_20", "TIER_21", "TIER_22", "TIER_23", "TIER_24", "TIER_25", "TIER_26", "TIER_27", "TIER_28", "TIER_29", "TIER_30", "TIER_31" - `newTraveler.stealthType` (string) Stealth type. Enum: "STEALTH_TYPE_1", "STEALTH_TYPE_2", "STEALTH_TYPE_3" - `newTraveler.externalId` (string) A partner-assigned user identifier. This value must be unique for all travelers within a PNR. - `newTraveler.travelPreferences` (object) User's travel preferences - `newTraveler.travelPreferences.preferences` (object) Travel preferences. - `newTraveler.travelPreferences.preferences.airPref` (object) Travel preferences related to air travel. - `newTraveler.travelPreferences.preferences.airPref.airlinePrefs` (array) - `newTraveler.travelPreferences.preferences.airPref.airlinePrefs.airlines` (array) - `newTraveler.travelPreferences.preferences.airPref.airlinePrefs.flightType` (string) Enum: "UNKNOWN_FLIGHT_TYPE", "DOMESTIC", "INTERNATIONAL", "ALL" - `newTraveler.travelPreferences.preferences.airPref.alliancePref` (object) Alliance preferences. - `newTraveler.travelPreferences.preferences.airPref.alliancePref.alliances` (array, required) - `newTraveler.travelPreferences.preferences.airPref.farePref` (object) Fare preferences. - `newTraveler.travelPreferences.preferences.airPref.farePref.fareTypes` (array, required) - `newTraveler.travelPreferences.preferences.airPref.homeAirport` (string) Example: NEW YORK - `newTraveler.travelPreferences.preferences.airPref.mealPref` (object) Meal preferences. - `newTraveler.travelPreferences.preferences.airPref.mealPref.exclMealPrefs` (array) - `newTraveler.travelPreferences.preferences.airPref.mealPref.inclMealPrefs` (array) - `newTraveler.travelPreferences.preferences.airPref.mealPref.specialMealDescription` (string) Example: Veg only meal - `newTraveler.travelPreferences.preferences.airPref.numStopPref` (object) Preferred number of stops. - `newTraveler.travelPreferences.preferences.airPref.numStopPref.numOfStops` (integer, required) Example: 34 - `newTraveler.travelPreferences.preferences.airPref.seatAmenityPref` (object) Seat amenity preference. - `newTraveler.travelPreferences.preferences.airPref.seatAmenityPref.seatAmenityTypes` (array, required) - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs` (array) - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.cabins` (array) - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.isBulkHeadPref` (boolean) Example: false - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.maxFlightDurationInHours` (integer) Example: 3 - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.position` (string) Enum: "UNKNOWN_POSITION", "AISLE", "WINDOW", "AISLE_OR_WINDOW" - `newTraveler.travelPreferences.preferences.airPref.preferredAirports` (array) A list of user preferred airports. - `newTraveler.travelPreferences.preferences.airPref.preferredAirports.airportName` (string) Airport name. Example: San Francisco International Airport - `newTraveler.travelPreferences.preferences.airPref.preferredAirports.airportCode` (string, required) IATA airport code. Example: SFO - `newTraveler.travelPreferences.preferences.airPref.preferredAirports.label` (string, required) The label of preferred airport or rail station. Enum: "HOME", "WORK", "OTHER" - `newTraveler.travelPreferences.preferences.preferredCurrency` (string) Example: USD - `newTraveler.travelPreferences.preferences.railCards` (array) - `newTraveler.travelPreferences.preferences.railCards.cardNumber` (string) Number of card - `newTraveler.travelPreferences.preferences.railCards.name` (string, required) Name of the Rail Card. Example: Veterans Railcard - `newTraveler.travelPreferences.preferences.railCards.spotnanaCode` (string, required) Unique Spotnana code/identifier for Rail Card. Example: VET - `newTraveler.travelPreferences.preferences.railCards.vendor` (string, required) Vendor Name. Example: ATOC - `newTraveler.travelPreferences.preferences.railPref` (object) Travel preferences related to rail station. - `newTraveler.travelPreferences.preferences.railPref.preferredRailStations` (array) A list of user preferred rail stations. - `newTraveler.travelPreferences.preferences.railPref.preferredRailStations.stationName` (string) Rail station name. Example: Chicago Union Station - `newTraveler.travelPreferences.preferences.railPref.preferredRailStations.stationCode` (string, required) Rail station code. Example: CHI - `newTraveler.travelPreferences.preferences.railPref.preferredRailStations.cityName` (string) Name of city where the rail station is located. Example: Chicago - `newTraveler.travelPreferences.preferences.railPref.preferredRailStations.countryCode` (string) Alpha-2 country code where the rail station is located. - `newTraveler.travelPreferences.preferences.railPref.seatPreference` (object) Preference about seat of rail. - `newTraveler.travelPreferences.preferences.railPref.seatPreference.hasAccessibility` (boolean) Whether or not requires assistance for disability. Example: false - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatTypes` (array) - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatLocations` (array) - `newTraveler.travelPreferences.preferences.railPref.seatPreference.deckLevels` (array) - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatDirections` (array) - `newTraveler.travelPreferences.preferences.railPref.travelClasses` (array) A list of class of service for rail. - `newTraveler.travelPreferences.preferences.railPref.coachPreferences` (array) A list of coach preference for rail. - `newTraveler.travelPreferences.preferences.railPref.conditionalRates` (array) A list of conditional rates for rail. - `newTraveler.travelPreferences.preferences.carPref` (object) Travel preferences related to car. - `newTraveler.travelPreferences.preferences.carPref.vendors` (array) A list of car vendors. - `newTraveler.travelPreferences.preferences.carPref.vendors.code` (string, required) Vendor code Example: ZE - `newTraveler.travelPreferences.preferences.carPref.vendors.name` (string, required) Vendor name Example: HERTZ - `newTraveler.travelPreferences.preferences.carPref.vendors.isPresentInPreferredVendors` (boolean) Whether the car vendor is present in preferred vendor list. This is an optional field which gets populated only in the preferred vendor autocomplete API. Example: true - `newTraveler.travelPreferences.preferences.carPref.carTypes` (array) A list of types of car. - `newTraveler.travelPreferences.preferences.carPref.engineTypes` (array) A list of types of engine. - `newTraveler.travelPreferences.preferences.carPref.transmissionTypes` (array) A list of types of transmission. - `newTraveler.travelPreferences.preferences.carPref.conditionalRates` (array) A list of conditional rates for rail. - `newTraveler.travelPreferences.preferences.hotelPref` (object) Travel preferences related to hotel. - `newTraveler.travelPreferences.preferences.hotelPref.hotelParentChains` (array) A list of hotel parent chains. - `newTraveler.travelPreferences.preferences.hotelPref.hotelParentChains.chainCode` (string) The code of hotel chain. Example: EM - `newTraveler.travelPreferences.preferences.hotelPref.hotelParentChains.chainName` (string) The name of hotel chain. Example: Mariott - `newTraveler.travelPreferences.preferences.hotelPref.hotelBrands` (array) A list of hotel brands. - `newTraveler.travelPreferences.preferences.hotelPref.hotelBrands.brandCode` (string) The code of hotel brand. Example: HY - `newTraveler.travelPreferences.preferences.hotelPref.hotelBrands.brandName` (string) The name of hotel brand. Example: Global Hytt Corp. - `newTraveler.travelPreferences.preferences.hotelPref.hotelAmenityTypes` (array) A list of HotelAmenities. - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference` (object) Room options and stay preference. - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.isMobilityAccessible` (boolean) Whether or not mobility accessible room, tub. Example: false - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.bedCount` (string) The number of bed in the room. Enum: "ONE_BED", "TWO_BEDS" - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.roomType` (string) Single selection of type of room. Enum: "SMOKING", "NON_SMOKING" - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.mostImportantFact` (string) Single selection of the most import fact. Enum: "ROOM_TYPE", "BED_COUNT", "ROOM_LOCATION" - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.roomLocation` (string) Location of the hotel room Enum: "HIGH_FLOOR", "LOW_FLOOR", "NEAR_ELEVATOR" - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.pillowType` (string) The type of pillow in hotel room. Enum: "FOAM", "EXTRA_FOAM", "EXTRA_FEATHER" - `newTraveler.travelPreferences.preferences.hotelPref.roomPreference.roomAmenityPrefs` (array) - `newTraveler.travelPreferences.preferences.hotelPref.conditionalRates` (array) A list of conditional rates for rail. - `newTraveler.membershipInfo` (object) User's loyalty program membership details. - `newTraveler.membershipInfo.membershipInfos` (array) - `newTraveler.membershipInfo.membershipInfos.appliedTo` (array) - `newTraveler.membershipInfo.membershipInfos.id` (string, required) Example: firstId - `newTraveler.membershipInfo.membershipInfos.issuedBy` (string, required) Example: firstIssuedBy - `newTraveler.membershipInfo.membershipInfos.type` (string, required) Enum: "UNKNOWN_TYPE", "AIR", "HOTEL", "CAR", "RAIL" - `newTraveler.membershipInfo.membershipInfos.linked` (boolean) Indicates if this loyalty account is linked to the external provider. Only applicable for certain loyalty types. Example: false - `newTraveler.membershipInfo.membershipInfos.tier` (string) Loyalty membership tier name echoed from the supplier. Example: GOLD - `newTraveler.membershipInfo.isLoyaltyBlocked` (boolean) Whether user is blocked to use loyalty programs. This is a read only field. Example: false - `newTraveler.notificationPreferences` (object) Notification preferences of a user for different notification types. - `newTraveler.notificationPreferences.preferences` (array) - `newTraveler.notificationPreferences.preferences.notificationType` (string) Enum: "FLIGHT_NOTIFICATION", "BOOKING_NOTIFICATION" - `newTraveler.notificationPreferences.preferences.emailPreference` (object) Email preference for notification type. - `newTraveler.notificationPreferences.preferences.emailPreference.enabled` (boolean) Whether the email preference is enabled or not. - `newTraveler.notificationPreferences.preferences.emailPreference.ccEmails` (array) List of cc emails for the email preference. - `newTraveler.travelArrangers` (object) Travel arrangers for a user. - `newTraveler.travelArrangers.travelArrangers` (array, required) - `newTraveler.travelArrangers.travelArrangers.email` (string) Example: example@email.com - `newTraveler.travelArrangers.travelArrangers.phoneNumbers` (array) - `newTraveler.travelArrangers.travelArrangers.status` (string) Status of the traveler-arranger assignment. Enum: "PENDING", "ACCEPTED", "DENIED" - `newTraveler.adhocUserInfo` (object) Basic information related to ad-hoc traveler profile. - `newTraveler.adhocUserInfo.profileOwner` (object, required) Basic information about the owner of the ad-hoc user. - `newTraveler.adhocUserInfo.isSaved` (boolean) A boolean flag to show if ad-hoc traveler is visible in search. While updating the user if client tries to update this field, it will throw exception. - `newTraveler.roles` (array) - `newTraveler.roles.roleType` (string) Enum: "COMPANY_ADMIN", "COMPANY_TRAVEL_ARRANGER", "TRAVEL_ARRANGER", "COMPANY_REPORT_ADMIN", "TMC_ADMIN", "TMC_AGENT", "GLOBAL_ADMIN", "GLOBAL_AGENT" - `newTraveler.roles.roleMetadata` (object) - `newTraveler.roles.roleMetadata.travelArrangerMetadata` (object) - `newTraveler.roles.roleMetadata.travelArrangerMetadata.arrangerFor` (array, required) - `newTraveler.roles.roleMetadata.travelArrangerMetadata.arrangerFor.userId` (string) - `newTraveler.roles.roleMetadata.travelArrangerMetadata.arrangerFor.sendConfirmationEmail` (boolean) Whether or not to send confirmation emails to user. Example: false - `newTraveler.roles.roleMetadata.travelArrangerMetadata.arrangerFor.sendFlightStatsNotificationEmail` (boolean) Whether or not to send flight stat notifications to user. Example: false - `newTraveler.roles.metadata` (object) - `newTraveler.roles.metadata.roleType` (string, required) Discriminator property for role metadata. Enum: "TRAVEL_ARRANGER" - `newTraveler.roles.metadata.arrangerFor` (array, required) - `newTraveler.roles.metadata.roleType` (string, required) Role type for which company reference metadata is specified. Enum: "COMPANY_ADMIN" - `newTraveler.roles.metadata.roleType` (string, required) Role type for which tmc reference metadata is specified. Enum: "TMC_ADMIN" ## Response 200: - `200` (unknown) OK ## Response 200 fields (application/json): - `id` (string, required) Id of the created event - `userId` (object) User identifier - `userId.id` (string, required) ## Response 400: - `400` (unknown) Bad request ## Response 400 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error. ## Response 401: - `401` (unknown) Unauthorized ## Response 401 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error. ## Response 403: - `403` (unknown) Forbidden ## Response 403 fields (application/json): - `debugIdentifier` (string) Link to debug the error internally. - `errorMessages` (array) - `errorMessages.errorCode` (string) Error code to identify the specific errors. - `errorMessages.message` (string) Message containing details of error. - `errorMessages.errorParameters` (array) Error message parameters. - `errorMessages.errorParameters.name` (string) Parameter name - `errorMessages.errorParameters.value` (string) Parameter value - `errorMessages.errorDetail` (string) More details about the error.