# 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 ## 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" - `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` (any, required) - `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" - `endDateTime` (object) Local date and time in ISO 8601 format. - `location` (object, required) Location for an event - `location.address` (object) Postal Address Details - `location.address.addressLines` (array, required) Address lines Example: ["Golden Gate Bridge"] - `location.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" - `location.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" - `location.address.description` (string) Address description Example: "San Francisco Home" - `location.address.isDefault` (boolean) Whether this address is default address in case multiple addresses are specified. Example: true - `location.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" - `location.address.locality` (string) Generally refers to the city/town portion of the address. Example: "San Francisco" - `location.address.locationCode` (string) IATA 3-letter location code. See https://www.iata.org/en/services/codes. Example: "LAX" - `location.address.organization` (string) The name of the organization at the address. Example: "Spotnana" - `location.address.postalCode` (string) Postal code of the address. This is a required field when setting for a user/legal entity/company etc. Example: "94130" - `location.address.continentCode` (string) 2 letter continent code of the continent this address falls in. Example: "AF" - `location.address.recipients` (array) The recipient at the address. - `location.address.regionCode` (string, required) Region code of the country/region of the address. Example: "US" - `location.address.regionName` (string) Region name of the country/region of the address. Example: "America" - `location.address.revision` (integer) Example: 1 - `location.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" - `location.address.sublocality` (string) Sublocality of the address. This can be neighborhoods, boroughs, districts. - `location.address.timezone` (string) Time zone of the address. Example: "America/Los_Angeles" - `location.address.coordinates` (object) Map coordinates of the address. - `location.address.coordinates.latitude` (number, required) Latitude of the Location Example: 77.1025 - `location.address.coordinates.longitude` (number, required) Longitude of the Location Example: 28.7041 - `location.coordinates` (object) Latitude and Longitude for a Location - `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 - `allowedBookingTypes` (array) Allowed booking types for the event group Enum: "AIR", "HOTEL", "CAR", "RAIL" - `externalId` (string) External Id for the event Example: "qwert123" - `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 - `parentEventId` (string) Optional parent event's id. Example: "56789012" - `companyId` (object) Company id - `bookingStyle` (string) Whether the event bookings will be self served by the traveler or would be arranged by an agent for the traveler. Enum: "SELF_SERVE", "AGENT_MANAGED" - `referenceUsers` (array) Event group reference user ids - `travelerTypes` (array) Allowed traveler types for the event Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC" - `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. Enum: "BOOKING_CONFIRMATIONS", "BOOKING_CHANGES", "FLIGHT_UPDATES", "APPROVAL_REQUESTS", "APPROVAL_UPDATES", "REMINDERS", "INVOICE_UPDATES" - `emailPreferences.isEnabled` (boolean) Indicates whether emails are disabled. - `emailPreferences.toEmails` (array) List of email address to be included in emails. Example: ["example@email.com"] - `emailPreferences.ccEmails` (array) List of email address to be cc-ed in emails. Example: ["example@email.com"] - `emailPreferences.bccEmails` (array) List of email address to be bcc-ed in emails. Example: ["example@email.com"] - `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 - `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.name` (string) Example: "Name" - `tripOverrides.costCenter` (object, required) Cost center override - `tripOverrides.costCenter.costCenterRef` (object) Reference of an entity - `tripOverrides.department` (object, required) Department override - `tripOverrides.department.departmentRef` (object) Reference of an entity - `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", "NATIONAL", "ALAMO", "HERTZ", "DOLLAR", "THRIFTY", "FIREFLY", "EUROSTAR", "AVIS", "BUDGET" - `tripOverrides.rateCodeOverrides.travelType` (string) Travel Type Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL" - `tripOverrides.rateCodeOverrides.rateCodeIds` (array) List of rate code ids Example: ["f49d00fe-1eda-4304-ba79-a980f565281d"] - `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.phoneNumber` (object) Phone no. of the trip contact - `tripContacts.phoneNumber.countryCode` (integer) two digit country code Example: 91 - `tripContacts.phoneNumber.countryCodeSource` (string) Enum: "UNSPECIFIED", "FROM_NUMBER_WITH_PLUS_SIGN", "FROM_NUMBER_WITH_IDD", "FROM_NUMBER_WITHOUT_PLUS_SIGN", "FROM_DEFAULT_COUNTRY" - `tripContacts.phoneNumber.extension` (string) phone number extension Example: "222" - `tripContacts.phoneNumber.isoCountryCode` (string) ISO alpha-2 code Example: "IN" - `tripContacts.phoneNumber.italianLeadingZero` (boolean) Example: true - `tripContacts.phoneNumber.nationalNumber` (integer) Example: 8150 - `tripContacts.phoneNumber.numberOfLeadingZeros` (integer) Example: 1 - `tripContacts.phoneNumber.preferredDomesticCarrierCode` (string) Example: "7" - `tripContacts.phoneNumber.rawInput` (string) Example: "77777" - `tripContacts.phoneNumber.type` (string) Enum: "UNKNOWN_TYPE", "MOBILE", "LANDLINE" - `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 Example: ["f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"] - `inviteEmailConfig` (object) Configuration for event invite/reminder emails - `inviteEmailConfig.emailExcludeCoordinatorInfo` (boolean) Whether to exclude coordinator information in emails sent to travelers. 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) Optional new traveler to create before event creation. The backend creates the traveler and adds the userId to the travellers list. If the traveler already exists, the request fails — use the travellers field with the existing userId. - `newTraveler.personalInfo` (object) User details. - `newTraveler.personalInfo.addresses` (array) - `newTraveler.personalInfo.dob` (object) Date in ISO 8601 standard. - `newTraveler.personalInfo.email` (string) Example: "example@email.com" - `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","issueCountry":"US"}}] - `newTraveler.personalInfo.name` (object) Full name containing first, middle, last (family) names, and suffix. - `newTraveler.personalInfo.name.family1` (string, required) Last (family) name. Example: "Gandas" - `newTraveler.personalInfo.name.family2` (string) Example: "FamilyTwo" - `newTraveler.personalInfo.name.given` (string, required) First (given) name. Example: "Vichitr" - `newTraveler.personalInfo.name.middle` (string) Middle name. Example: "Kumar" - `newTraveler.personalInfo.name.suffix` (string) Suffix used with the name. For example SR or JR. Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD" - `newTraveler.personalInfo.name.preferred` (string) Informal preferred name added by traveler. This is not used on any PNR or tickets Example: "Don" - `newTraveler.personalInfo.phoneNumbers` (array) - `newTraveler.personalInfo.profilePicture` (object) An image with meta data. Either the data or url property must be supplied to load the image. - `newTraveler.personalInfo.profilePicture.data` (string) Example: "6935813e12584abda0e43d71cd2ea260" - `newTraveler.personalInfo.profilePicture.dimensions` (object) Image dimensions ie width and height. - `newTraveler.personalInfo.profilePicture.dimensions.height` (integer) Example: 120 - `newTraveler.personalInfo.profilePicture.dimensions.width` (integer) Example: 240 - `newTraveler.personalInfo.profilePicture.url` (string) Example: "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp" - `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) Pronoun preferred by user. Enum: "SHE_HER_HERS", "HE_HIM_HIS", "THEY_THEM_THEIRS" - `newTraveler.personalInfo.travelerName` (object) A name of user that does not contain special characters. - `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.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.designation` (string) Job title of contact. Example: "MANAGER" - `newTraveler.personalInfo.emergencyContactInfo` (object) Emergency contact information. - `newTraveler.personalInfo.emergencyContactInfo.designation` (string) Example: "MANAGER" - `newTraveler.personalInfo.emergencyContactInfo.phoneNumber` (object) Properly formatted phone number. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId` (object) User and user's organization information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationId` (object, required) Organization id for traveler. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.userId` (object, required) User identifier - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo` (object) TMC related basic information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.contractingTmc` (object, required) Contracting TMC is the TMC the user/organization contracted. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.contractingTmc.id` (object, required) Company ID - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.contractingTmc.logo` (object) Company logo - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcBasicInfo.bookingTmc` (object, required) Booking TMC is the TMC used for the bookings for the user/organization. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.organizationAgencyId` (object) Agency id for the organization. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo` (object) TMC config information. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.id` (object, required) TMC id. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.primaryServiceProviderTmc` (object, required) Primary service provider TMC for the TMC. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.primaryServiceProviderTmc.tmcId` (object, required) Id of the service provider TMC. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.secondaryServiceProviderTmcs` (array) Secondary service provider TMCs for the TMC. - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.secondaryServiceProviderTmcs.supplier` (string, required) Supplier for which this service provider should be used. 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", "NATIONAL", "ALAMO", "HERTZ", "DOLLAR", "THRIFTY", "FIREFLY", "EUROSTAR", "AVIS", "BUDGET" - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.secondaryServiceProviderTmcs.travelType` (string, required) Travel type for which this service provider should be used. Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL" - `newTraveler.personalInfo.emergencyContactInfo.userOrgId.tmcInfo.partnerTmcId` (object) Useful to identify the clients onboarded by a PARTNER_TMC - `newTraveler.businessInfo` (object) User business information. - `newTraveler.businessInfo.employeeId` (string) Unique employee id. Can use email if a company don't use employee ids. Example: "101" - `newTraveler.businessInfo.gradeRef` (object) Reference of an entity - `newTraveler.businessInfo.managerRef` (object) Reference of an entity - `newTraveler.businessInfo.officeRef` (object) Reference of an entity - `newTraveler.businessInfo.organizationRef` (object, required) Reference of an entity - `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.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.persona` (string, required) Persona of the user Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC" - `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) Example: ["Indigo"] - `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) Enum: "UNKNOWN_ALLIANCE", "STAR_ALLIANCE", "ONEWORLD", "SKYTEAM", "VANILLA_ALLIANCE", "U_FLY_ALLIANCE", "VALUE_ALLIANCE" - `newTraveler.travelPreferences.preferences.airPref.farePref` (object) Fare preferences. - `newTraveler.travelPreferences.preferences.airPref.farePref.fareTypes` (array, required) Enum: "UNKNOWN_TYPE", "CHANGEABLE", "REFUNDABLE" - `newTraveler.travelPreferences.preferences.airPref.homeAirport` (string) Example: "NEW YORK" - `newTraveler.travelPreferences.preferences.airPref.mealPref` (object) Meal preferences. - `newTraveler.travelPreferences.preferences.airPref.mealPref.exclMealPrefs` (array) Enum: "UNKNOWN_MEAL", "AVML", "BBML", "BLML", "CHML", "DBML", "FPML", "GFML", "HFML", "HNML", "KSML", "LCML", "LFML", "LPML", "LSML", "MOML", "NLML", "NSML", "ORML", "PFML", "RVML", "SFML", "SPML", "VGML", "VJML", "VLML", "VOML" - `newTraveler.travelPreferences.preferences.airPref.mealPref.inclMealPrefs` (array) Enum: "UNKNOWN_MEAL", "AVML", "BBML", "BLML", "CHML", "DBML", "FPML", "GFML", "HFML", "HNML", "KSML", "LCML", "LFML", "LPML", "LSML", "MOML", "NLML", "NSML", "ORML", "PFML", "RVML", "SFML", "SPML", "VGML", "VJML", "VLML", "VOML" - `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) Enum: "UNKNOWN_AIR_SEAT_AMENITY_TYPE", "FLAT_BED", "WIFI", "IN_SEAT_POWER" - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs` (array) - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.cabins` (array) Enum: "UNKNOWN_CABIN", "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST" - `newTraveler.travelPreferences.preferences.airPref.seatLocationPrefs.isBulkHeadPref` (boolean) - `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.expiryDate` (object) Expiry date of the Rail 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. - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatTypes` (array) Enum: "SLEEPER_BED", "NORMAL", "TABLE_SEAT" - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatLocations` (array) Enum: "AISLE", "WINDOW", "SOLO" - `newTraveler.travelPreferences.preferences.railPref.seatPreference.deckLevels` (array) Enum: "UPPER_DECK", "LOWER_DECK" - `newTraveler.travelPreferences.preferences.railPref.seatPreference.seatDirections` (array) Enum: "FORWARD", "BACKWARD" - `newTraveler.travelPreferences.preferences.railPref.travelClasses` (array) A list of class of service for rail. Enum: "FIRST", "STANDARD", "BUSINESS", "SLEEPER", "STANDARD_PREMIUM", "BUSINESS_PREMIUM", "COACH", "ROOM", "EXECUTIVE" - `newTraveler.travelPreferences.preferences.railPref.coachPreferences` (array) A list of coach preference for rail. Enum: "SMOKING", "NON_SMOKING", "PETS_ALLOWED", "RESTAURANT", "QUIET" - `newTraveler.travelPreferences.preferences.railPref.conditionalRates` (array) A list of conditional rates for rail. Enum: "MILITARY", "AAA", "GOVERNMENT" - `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. Enum: "OTHER", "MINI", "ECONOMY", "COMPACT", "MID_SIZE", "STANDARD", "FULL_SIZE", "PREMIUM", "LUXURY", "CONVERTIBLE", "MINIVAN", "SUV", "VAN", "PICKUP", "SPORTS", "SPECIAL", "RECREATIONAL_VEHICLE", "WAGON" - `newTraveler.travelPreferences.preferences.carPref.engineTypes` (array) A list of types of engine. Enum: "UNKNOWN_ENGINE", "PETROL", "DIESEL", "ELECTRIC", "CNG", "HYBRID", "HYDROGEN", "MULTI_FUEL", "ETHANOL" - `newTraveler.travelPreferences.preferences.carPref.transmissionTypes` (array) A list of types of transmission. Enum: "MANUAL", "AUTOMATIC" - `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. Enum: "PARKING", "FREE_PARKING", "FREE_BREAKFAST", "POOL", "WIFI", "FITNESS_CENTER", "FAMILY_FRIENDLY", "RECEPTION", "SPA", "RESTAURANT", "BAR", "TRANSPORTATION", "PET_FRIENDLY", "BUSINESS_CENTER", "AIR_CONDITIONING", "BEACH_ACCESS", "LAUNDRY_SERVICES", "ROOM_SERVICE", "ACCESSIBLE" - `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. - `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) Enum: "FEATHER_FREE_ROOM", "EXTRA_TOWELS", "REFRIGERATOR" - `newTraveler.membershipInfo` (object) User's loyalty program membership details. - `newTraveler.membershipInfo.membershipInfos` (array) - `newTraveler.membershipInfo.membershipInfos.appliedTo` (array) Example: ["TAJ"] - `newTraveler.membershipInfo.membershipInfos.issuedBy` (string, required) Example: "firstIssuedBy" - `newTraveler.membershipInfo.membershipInfos.linked` (boolean) Indicates if this loyalty account is linked to the external provider. Only applicable for certain loyalty types. - `newTraveler.membershipInfo.membershipInfos.tier` (string) Loyalty membership tier name echoed from the supplier. - `newTraveler.membershipInfo.isLoyaltyBlocked` (boolean) Whether user is blocked to use loyalty programs. This is a read only field. - `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.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.metadata` (any) - `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. - `newTraveler.roles.roleMetadata.travelArrangerMetadata.arrangerFor.sendFlightStatsNotificationEmail` (boolean) Whether or not to send flight stat notifications to user. - `newTraveler.relativeOf` (object) Link to primary traveler - `newTraveler.relativeOf.userRef` (object) Reference of an entity - `newTraveler.relativeOf.relation` (string) Enum: "SPOUSE", "CHILD", "FRIEND", "PARENT", "OTHER" - `newTraveler.travelArrangers` (object) Travel arrangers for a user. - `newTraveler.travelArrangers.travelArrangers` (array, required) - `newTraveler.travelArrangers.travelArrangers.status` (string) Status of the traveler-arranger assignment. Enum: "PENDING", "ACCEPTED", "DENIED" - `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 the given custom field. Enum: "HIDDEN", "READ_ACCESS", "WRITE_ACCESS" ## Response 200 fields (application/json): - `id` (string, required) Id of the created event - `userId` (object) Id of the newly created user, if a new traveler was created - `userId.id` (string, required) ## 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 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 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.