--- title: "Create event" method: POST path: "/v2/events" tags: ["Events"] --- # Create event `POST /v2/events` 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. ## Request body - CreateEventRequest — Create Event request object - `name` string, required — Name of the event - `description` string — Description of the event - `documents` Document[] — Documents attached for an event - `url` string, required — S3 location of the document. - `documentId` string, uuid, required — Unique identifier of the document. - `documentMetadata` DocumentMetadata, required — Metadata related to document. - `documentType` 'BOARDING_PASS' | 'CONFIRMATION' | 'INVOICE' | 'VISA' | 'MISCELLANEOUS' | 'OTHERS' | 'TASK_PROCESSOR' | 'EVENT_COVER_IMAGE' | 'LOGO_IMAGE', required — Document type. - `entityType` 'PNR' | 'COMPANY' | 'AIR_ITINERARY' | 'EVENT' | 'LOCATION_IMAGE' | 'AIR_COMMISSION_CONTRACT', required — Entity type against which the document is to uploaded. - `entityId` string, required — Entity Id for the given entity type. - `entityMetadata` union, required — Metadata for associated entity of document. - object - `pnrMetadata` union — Metadata when document is associated to pnr entity. - object - … - object - … - `invoiceMetadata` object — Metadata associated with an invoice document. - `invoiceNumber` string, required - `invoiceType` 'SERVICE_FEE_INVOICE' | 'FARE_INVOICE' | 'GENERIC_INVOICE' - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL', required — Travel Type - object - `eventMetadata` EventEntityMetadata — Metadata when document is associated to an event. - `address` PostalAddress — Postal Address Details - … - `name` string, required — Document name. - `startDateTime` DateTimeLocal — Local date and time in ISO 8601 format. - `iso8601` string, required - `endDateTime` DateTimeLocal — Local date and time in ISO 8601 format. - `iso8601` string, required - `location` EventLocation, required — Location for an event - `address` PostalAddress — Postal Address Details - `addressLines` string[], required — Address lines - `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. - `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. - `description` string — Address description - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified. - `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". - `locality` string — Generally refers to the city/town portion of the address. - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes. - `organization` string — The name of the organization at the address. - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc. - `continentCode` string — 2 letter continent code of the continent this address falls in. - `recipients` string[] — The recipient at the address. - `regionCode` string, required — Region code of the country/region of the address. - `regionName` string — Region name of the country/region of the address. - `revision` integer - `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). - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts. - `timezone` string — Time zone of the address. - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `contacts` UserId[] — Contacts for the event - `id` string, uuid, required - `bookingGuidelines` EventBookingGuideline[] — A list of booking guideline for the event. - union — Booking details allowed for the event - object — Wrapper for AirBookingGuideline - `airBookingGuideLine` AirBookingGuideline — Air related guidelines - `allowedAirports` AirportInfo[] — List of allowed airports for arrival of flight-in-event and departure of flight-out-event. - `airportCode` string — 3-letter code of the airport. - `airportName` string — Full name of the airport. - `cityName` string — Name of the city in which the airport is located (or is nearest to). - `countryName` string — Name of the country in which the airport is located. - `countryCode` string — 2-letter IATA country code associated with the airport. - `zoneName` string — Name of the time zone associated with the airport. - `stateCode` string — 2-letter IATA code for the state in which the airport is located. - `allowedCityCodes` string[] — 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. - `arrivalBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `departureBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `allowedFlightGuidelines` AllowedFlightGuideline[] — List of allowed flight guidelines for the event. - `allowedFlightType` 'ONE_WAY' | 'ROUND_TRIP' | 'MULTICITY', required — The types of flight booking guidelines - `numberOfLegs` integer — The number of legs allowed for the flight booking. - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for HotelBookingGuideline - `hotelBookingGuideLine` HotelBookingGuideline — Hotel related guidelines - `allowedHotels` HotelInfo[] — List of allowed Hotel details for the event - `address` PostalAddress, required — Postal Address Details - … - `chainCode` string — Chain code of the hotel. - `chainName` string — Chain name of the hotel. - `coordinates` Latlng — Latitude and Longitude for a Location - … - `email` string — Email address of the hotel. - `hotelId` string — Hotel id. - `name` string, required — Name of the hotel. - `phone` PhoneNumber — Properly formatted phone number. - … - `starRating` number, double — Star rating of the hotel. - `fax` PhoneNumber[] - … - `masterChainCode` string — Master chain code of the hotel. - `brandName` string — Brand name of the hotel. - `amenities` HotelAmenities[] - … - `additionalAmenities` string[] — List of amenities provided by the supplier. - `imageSets` HotelImageSet[] - … - `descriptions` HotelDescription[] - … - `thirdPartyHotelCodes` ThirdPartyHotelCode[] - … - `checkinBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `checkoutBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `paymentGuidelines` HotelBookingPaymentGuidelines — Hotel booking payment guidelines - `onlyVpayEnabledBooking` boolean — Whether only Vpay enabled bookings are allowed for the event. - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for CarBookingGuideline - `carBookingGuideLine` CarBookingGuideline — Car related guidelines - `pickupBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `dropoffBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `paymentGuidelines` CarBookingPaymentGuidelines — Car booking payment guidelines - `allowedPaymentVendors` VendorInfo[] — List of allowed car vendors for the event - … - `onlyVendorBooking` boolean — Whether only Vendor bookings are allowed for the event. - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - object — Wrapper for RailBookingGuideline - `railBookingGuideLine` RailBookingGuideline — Rail related guidelines - `arrivalBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `departureBookingWindow` EventBookingWindow — Event booking window - `startDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `endDateTime` DateTimeLocal, required — Local date and time in ISO 8601 format. - … - `numGuestsAllowed` integer — Number of guests allowed to be booked for this booking - `allowedBookingTypes` EventAllowedBookingType[] — Allowed booking types for the event group - `externalId` string — External Id for the event - `eventCustomFieldResponses` CustomFieldResponse[] — List of custom field responses for the event. - `customFieldId` string, uuid, required — The unique identifier for the custom field. - `responseItems` CustomFieldResponseItem[] — Responses selected by the event coordinator. - `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. - `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. - `travelerAccess` 'HIDDEN' | 'READ_ACCESS' | 'WRITE_ACCESS', required — Traveler access for a custom field - `eventCustomFieldV3Responses` CustomFieldPrefilledResponse[] — List of custom field responses for an event. - `fieldId` string, uuid, required — Custom field id - `fieldName` string — Name of the custom field - `armId` string, uuid, required — Arm id which is applicable - `readOnly` boolean — Indicates whether the user can change the pre-selected options. - `hidden` boolean — Whether this code will be hidden to the user. - `selectedOptions` CustomFieldSelectedOption[], required — The list of options that are selected by user or auto populated. - `name` string, required — Value of the selection - `translatedName` string — Translated value of the selection - `description` string — Description of the selection - `translatedDescription` string — Translated description of the selection - `additionalUserInput` string — Additional user input - `additionalInfos` string[] — Actual values of the additional infos - `additionalInfoConfigs` AdditionalInfo[] — Additional info configs for the selected option - union — Additional data need to be sent along with the custom field response. - object — Variable defining the additional value to be sent along with custom field response. - `type` string, required - `name` 'PUBLISHED_FARE' | 'LLF' | 'ADD_COLLECT_AMOUNT' | 'SELECTED_FARE' | 'SPLIT_PAYMENT_FARE', required — Name of the variable. - object — Expression consisting of variables and constants which needs to be sent along with custom field response. - `type` string, required - `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. - `variables` VariableName[] — Reference names of the variables present in the expression. - `parentEventId` string — Optional parent event's id. - `companyId` CompanyId — Company ID - `id` string, uuid, required - `bookingStyle` 'SELF_SERVE' | 'AGENT_MANAGED' — The booking style for the event's participants. - `referenceUsers` UserId[] — Event group reference user ids - `id` string, uuid, required - `travelerTypes` Persona[] — Allowed traveler types for the event - `policyId` string, uuid — Policy associated with the event. - `travellers` UserId[] — Travellers associated with the event - `id` string, uuid, required - `type` 'GENERIC' | 'PROGRAM' | 'PROGRAM_SESSION' | 'PROGRAM_TRIP' — Type of an event - `allowTravelersPolicy` 'ALLOWED' | 'NOT_ALLOWED' — Apply travelers policy when it is less restrictive. - `emailPreferences` BucketEmailPreferences — Email communication preferences based on bucket types. - `bucketTypes` EmailBucketType[], required — List of email bucket types. - `isEnabled` boolean — Indicates whether emails are disabled. - `toEmails` string[] — List of email address to be included in emails. - `ccEmails` string[] — List of email address to be cc-ed in emails. - `bccEmails` string[] — List of email address to be bcc-ed in emails. - `internalNotes` string — Internal notes of the event - `allowTravelersToRsvp` 'ALLOWED' | 'NOT_ALLOWED' — Allow travelers to rsvp for the event - `tripOverrides` TripOverrides — Trip overrides for the event - `legalEntity` LegalEntityOverride, required — Legal entity override for the event - `behavior` 'OVERRIDE_ALLOWED' | 'OVERRIDE_NOT_ALLOWED' | 'OVERRIDE_MANDATORY', required — Override behavior for the trip overrides - `legalEntityRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `costCenter` CostCenterOverride, required — Cost center override for the event - `behavior` 'OVERRIDE_ALLOWED' | 'OVERRIDE_NOT_ALLOWED' | 'OVERRIDE_MANDATORY', required — Override behavior for the trip overrides - `costCenterRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `department` DepartmentOverride, required — Department override for the event - `behavior` 'OVERRIDE_ALLOWED' | 'OVERRIDE_NOT_ALLOWED' | 'OVERRIDE_MANDATORY', required — Override behavior for the trip overrides - `departmentRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `userAttributes` CompanySpecifiedAttributeOverride[], required — List of company specified attribute overrides - `behavior` 'OVERRIDE_ALLOWED' | 'OVERRIDE_NOT_ALLOWED' | 'OVERRIDE_MANDATORY', required — Override behavior for the trip overrides - `attribute` CompanySpecifiedUserAttribute, required — Company specified user arbitrary attribute. - `fixedColumnName` string, required - `value` string - `rateCodeOverrides` RateCodeOverride[] — List of rate codes to be overridden for a trip - `behavior` 'OVERRIDE_ALLOWED' | 'OVERRIDE_NOT_ALLOWED' | 'OVERRIDE_MANDATORY', required — Override behavior for the trip overrides - `supplier` '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' — Supplier type like Sabre, TravelFusion etc. - `travelType` 'AIR' | 'HOTEL' | 'CAR' | 'RAIL' | 'LIMO' | 'MISC' | 'ALL' — Travel Type - `rateCodeIds` string[] — List of rate code ids - `tripContacts` TripContact[] — Trip contacts for the event. These are passed through to created trips. - `label` string, required — Label for the contact - `name` string, required — Name of the contact - `email` string — Email of the contact - `phoneNumber` PhoneNumber — Properly formatted phone number. - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `isPrimary` boolean — Whether the contact is primary or not - `restrictVisibility` boolean — Whether to restrict visibility of the contact to only agents and admins - `inheritedCustomFieldIds` string[] — List of custom field IDs that were inherited from parent - `inviteEmailConfig` InviteEmailConfig — Configuration for event invite/reminder emails - `emailExcludeCoordinatorInfo` boolean — Whether to exclude coordinator information in emails sent to travelers. - `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` UserCreateRequest — Traveler details. - `personalInfo` UserPersonalInfo — User details. - `addresses` PostalAddress[] - `addressLines` string[], required — Address lines - `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. - `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. - `description` string — Address description - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified. - `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". - `locality` string — Generally refers to the city/town portion of the address. - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes. - `organization` string — The name of the organization at the address. - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc. - `continentCode` string — 2 letter continent code of the continent this address falls in. - `recipients` string[] — The recipient at the address. - `regionCode` string, required — Region code of the country/region of the address. - `regionName` string — Region name of the country/region of the address. - `revision` integer - `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). - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts. - `timezone` string — Time zone of the address. - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `dob` DateModel — Date in ISO 8601 standard. - `iso8601` string, required - `email` string, email - `emergencyContactInfo` EmergencyContactInfo — Emergency contact information. - `address` PostalAddress — Postal Address Details - `addressLines` string[], required — Address lines - `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. - `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. - `description` string — Address description - `isDefault` boolean — Whether this address is default address in case multiple addresses are specified. - `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". - `locality` string — Generally refers to the city/town portion of the address. - `locationCode` string — IATA 3-letter location code. See https://www.iata.org/en/services/codes. - `organization` string — The name of the organization at the address. - `postalCode` string — Postal code of the address. This is a required field when setting for a user/legal entity/company etc. - `continentCode` string — 2 letter continent code of the continent this address falls in. - `recipients` string[] — The recipient at the address. - `regionCode` string, required — Region code of the country/region of the address. - `regionName` string — Region name of the country/region of the address. - `revision` integer - `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). - `sublocality` string — Sublocality of the address. This can be neighborhoods, boroughs, districts. - `timezone` string — Time zone of the address. - `coordinates` Latlng — Latitude and Longitude for a Location - `latitude` number, double, required — Latitude of the Location - `longitude` number, double, required — Longitude of the Location - `designation` string - `email` string, email, required - `name` Name — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `phoneNumber` PhoneNumber — Properly formatted phone number. - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `userOrgId` UserOrgId — User and user's organization information. - `organizationAgencyId` OrganizationAgencyId — Agency id for the organization. - `id` string, required - `organizationId` OrganizationId, required — Organization id for traveler. - `id` string, required - `userId` UserId, required — User identifier - `id` string, uuid, required - `tmcInfo` TmcInfo — TMC config information. - `id` CompanyId, required — Company ID - … - `primaryServiceProviderTmc` PrimaryServiceProviderTmc, required — Primary service provider TMC info - … - `secondaryServiceProviderTmcs` SecondaryServiceProviderTmc[] — Secondary service provider TMCs for the TMC. - … - `partnerTmcId` CompanyId — Company ID - … - `tmcBasicInfo` TmcBasicInfo — TMC related basic information. - `contractingTmc` CompanyRef, required — Basic information about a company. - … - `bookingTmc` CompanyRef, required — Basic information about a company. - … - `gender` 'MALE' | 'FEMALE' | 'UNSPECIFIED' | 'UNDISCLOSED' | 'GENDER_REDACTED' - `identityDocs` IdentityDocument[] — List of user identity documents. - union — Identity document details. Currently supported documents are passport, immigration document, known traveler number, redress number and national document. - object - `passport` Passport — Passport details. - … - object - `immigrationDoc` ImmigrationDocument — Immigration document details. - … - object - `redress` RedressNumber — Redress details - … - object - `ktn` KnownTravelerNumber — Information about the Known Traveler Number (KTN). - … - object - `nationalDoc` NationalDoc — National Document Id details. - … - `name` Name — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `phoneNumbers` PhoneNumber[] - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `profilePicture` Image — An image with meta data. Either the `data` or `url` property must be supplied to load the image. - `data` string, byte - `dimensions` Dimensions — Image dimensions ie width and height. - `height` integer - `width` integer - `url` string - `nationality` string — Nationality of user - `title` 'TITLE_UNKNOWN' | 'MR' | 'MS' | 'MRS' | 'MX' | 'MASTER' | 'MISS' | 'DR' | 'PROFESSOR' | 'CAPTAIN' | 'REVEREND' | 'HONOURABLE' | 'SIR' | 'LADY' | 'AMBASSADOR' | 'LORD' | 'BRIGADIER' | 'SENATOR' | 'DAME' | 'JUSTICE' | 'UK' | 'TITLE_REDACTED' - `preferredLanguage` string — Language preferred by user. - `preferredPronoun` 'SHE_HER_HERS' | 'HE_HIM_HIS' | 'THEY_THEM_THEIRS' - `travelerName` Name — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `emergencyContact` EmergencyContact — Emergency contact information. - `name` string, required — Full name of contact. - `email` string, email — Email address of contact. - `designation` string — Job title of contact. - `relation` 'RELATION_UNKNOWN' | 'SPOUSE' | 'PARENT' | 'SIBLING' | 'CHILD' | 'FRIEND' | 'RELATIVE' | 'COLLEAGUE' | 'OTHER' — Relation of contact to user. - `phoneNumbers` PhoneNumber[], required — Phone numbers of contact. - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `preferredLanguage` string — Language preferred by user. - `businessInfo` BusinessInfo — User business information. - `departmentRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `designation` string - `email` string, email - `employeeId` string — Unique employee id. Can use email if a company don't use employee ids. - `gradeRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `legalEntityRef` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `managerRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `officeRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `organizationRef` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `phoneNumbers` PhoneNumber[] - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `costCenterRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `countryCode` string — alpha-2 or alpha-3 ISO country code. - `workerType` 'EMPLOYEE' | 'CONTINGENT' | 'SEASONAL' | 'INTERN' | 'GUEST' — The type of worker. - `accountingCode` string — Code used for accounting. - `companySpecifiedAttributes` CompanySpecifiedAttribute[] - `fixedColumnName` string, required - `value` string, required - `designatedApproverRefs` Reference[] — A list of references for designated approvers. - `id` string, uuid, required - `name` string - `authorizerEmail` string — Email address to be used as approval authorizer, when a manager is not present. - `persona` 'UNKNOWN_PERSONA' | 'EMPLOYEE' | 'GUEST' | 'PERSONAL' | 'RELATIVE' | 'ADHOC', required — Persona of the user - `relativeOf` RelativeOf — Link to primary traveler - `userRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `relation` 'SPOUSE' | 'CHILD' | 'FRIEND' | 'PARENT' | 'OTHER' - `billingCurrency` string — Preferred billing currency of the user - `tier` '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' — 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. - `stealthType` 'STEALTH_TYPE_1' | 'STEALTH_TYPE_2' | 'STEALTH_TYPE_3' — Stealth type. - `externalId` string — A partner-assigned user identifier. This value must be unique for all travelers within a PNR. - `travelPreferences` TravelPreferences — User's travel preferences - `preferences` TravelPref — Travel preferences. - `airPref` AirPref — Travel preferences related to air travel. - `airlinePrefs` AirlinePref[] - `airlines` string[] - `flightType` 'UNKNOWN_FLIGHT_TYPE' | 'DOMESTIC' | 'INTERNATIONAL' | 'ALL' - `alliancePref` AlliancePref — Alliance preferences. - `alliances` Alliance[], required - `farePref` FarePref — Fare preferences. - `fareTypes` string[], required - `homeAirport` string - `mealPref` MealPref — Meal preferences. - `exclMealPrefs` MealType[] - `inclMealPrefs` MealType[] - `specialMealDescription` string - `numStopPref` NumStopsPref — Preferred number of stops. - `numOfStops` integer, required - `seatAmenityPref` SeatAmenityPref — Seat amenity preference. - `seatAmenityTypes` string[], required - `seatLocationPrefs` SeatLocationPref[] - `cabins` string[] - `isBulkHeadPref` boolean - `maxFlightDurationInHours` integer - `position` 'UNKNOWN_POSITION' | 'AISLE' | 'WINDOW' | 'AISLE_OR_WINDOW' - `preferredAirports` PreferredAirport[] — A list of user preferred airports. - `airportName` string — Airport name. - `airportCode` string, required — IATA airport code. - `label` 'HOME' | 'WORK' | 'OTHER', required — The label of preferred airport or rail station. - `preferredCurrency` string - `railCards` RailCard[] - `cardNumber` string — Number of card - `expiryDate` DateModel — Date in ISO 8601 standard. - `iso8601` string, required - `name` string, required — Name of the Rail Card. - `spotnanaCode` string, required — Unique Spotnana code/identifier for Rail Card. - `vendor` string, required — Vendor Name. - `railPref` RailPref — Travel preferences related to rail station. - `preferredRailStations` PreferredRailStation[] — A list of user preferred rail stations. - `stationName` string — Rail station name. - `stationCode` string, required — Rail station code. - `cityName` string — Name of city where the rail station is located. - `countryCode` string — Alpha-2 country code where the rail station is located. - `label` 'HOME' | 'WORK' | 'OTHER', required — The label of preferred airport or rail station. - `seatPreference` SeatPref — Preference about seat of rail. - `hasAccessibility` boolean — Whether or not requires assistance for disability. - `seatTypes` SeatPrefType[] - `seatLocations` SeatPrefLocation[] - `deckLevels` DeckLevel[] - `seatDirections` SeatPrefDirection[] - `travelClasses` RailTravelClass[] — A list of class of service for rail. - `coachPreferences` CoachPref[] — A list of coach preference for rail. - `conditionalRates` ConditionalRate[] — A list of conditional rates for rail. - `carPref` CarPref — Travel preferences related to car. - `vendors` CarVendor[] — A list of car vendors. - `code` string, required — Vendor code - `name` string, required — Vendor name - `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. - `carTypes` CarType[] — A list of types of car. - `engineTypes` EngineType[] — A list of types of engine. - `transmissionTypes` TransmissionSearchFilter[] — A list of types of transmission. - `conditionalRates` ConditionalRate[] — A list of conditional rates for rail. - `hotelPref` HotelPref — Travel preferences related to hotel. - `hotelParentChains` HotelChain[] — A list of hotel parent chains. - `chainCode` string — The code of hotel chain. - `chainName` string — The name of hotel chain. - `hotelBrands` HotelBrand[] — A list of hotel brands. - `brandCode` string — The code of hotel brand. - `brandName` string — The name of hotel brand. - `hotelAmenityTypes` HotelPrefAmenity[] — A list of HotelAmenities. - `roomPreference` RoomPreference — Room options and stay preference. - `isMobilityAccessible` boolean — Whether or not mobility accessible room, tub. - `bedCount` 'ONE_BED' | 'TWO_BEDS' — The number of bed in the room. - `roomType` 'SMOKING' | 'NON_SMOKING' — Single selection of type of room. - `mostImportantFact` 'ROOM_TYPE' | 'BED_COUNT' | 'ROOM_LOCATION' — Single selection of the most import fact. - `roomLocation` 'HIGH_FLOOR' | 'LOW_FLOOR' | 'NEAR_ELEVATOR' — Location of the hotel room - `pillowType` 'FOAM' | 'EXTRA_FOAM' | 'EXTRA_FEATHER' — The type of pillow in hotel room. - `roomAmenityPrefs` string[] - `conditionalRates` ConditionalRate[] — A list of conditional rates for rail. - `membershipInfo` MembershipInfo — User's loyalty program membership details. - `membershipInfos` LoyaltyInfo[] - `appliedTo` string[] - `id` string, required - `issuedBy` string, required - `type` 'UNKNOWN_TYPE' | 'AIR' | 'HOTEL' | 'CAR' | 'RAIL', required - `linked` boolean — Indicates if this loyalty account is linked to the external provider. Only applicable for certain loyalty types. - `tier` string — Loyalty membership tier name echoed from the supplier. - `isLoyaltyBlocked` boolean — Whether user is blocked to use loyalty programs. This is a read only field. - `notificationPreferences` NotificationPreferences — Notification preferences of a user for different notification types. - `preferences` NotificationPreferencePerType[] - `notificationType` 'FLIGHT_NOTIFICATION' | 'BOOKING_NOTIFICATION' - `emailPreference` NotificationEmailPreference — Email preference for notification type. - `enabled` boolean — Whether the email preference is enabled or not. - `ccEmails` string[] — List of cc emails for the email preference. - `travelArrangers` UserTravelArrangers — Travel arrangers for a user. - `travelArrangers` TravelArrangerBasicInfo[], required - `name` Name — Full name containing first, middle, last (family) names, and suffix. - `family1` string, required — Last (family) name. - `family2` string - `given` string, required — First (given) name. - `middle` string — Middle name. - `suffix` 'NAME_SUFFIX_UNKNOWN' | 'SR' | 'JR' | 'MD' | 'PHD' | 'II' | 'III' | 'IV' | 'DO' | 'ATTY' | 'V' | 'VI' | 'ESQ' | 'DC' | 'DDS' | 'VM' | 'JD' | 'SECOND' | 'THIRD' — Suffix for name - `preferred` string — Informal preferred name added by traveler. This is not used on any PNR or tickets - `email` string, email - `phoneNumbers` PhoneNumber[] - `countryCode` integer — two digit country code - `countryCodeSource` 'UNSPECIFIED' | 'FROM_NUMBER_WITH_PLUS_SIGN' | 'FROM_NUMBER_WITH_IDD' | 'FROM_NUMBER_WITHOUT_PLUS_SIGN' | 'FROM_DEFAULT_COUNTRY' - `extension` string — phone number extension - `isoCountryCode` string — ISO alpha-2 code - `italianLeadingZero` boolean - `nationalNumber` integer - `numberOfLeadingZeros` integer - `preferredDomesticCarrierCode` string - `rawInput` string - `type` 'UNKNOWN_TYPE' | 'MOBILE' | 'LANDLINE' - `userId` UserId, required — User identifier - `id` string, uuid, required - `status` 'PENDING' | 'ACCEPTED' | 'DENIED' — Status of the traveler-arranger assignment. - `adhocUserInfo` AdhocUserInfo — Basic information related to ad-hoc traveler profile. - `profileOwner` ProfileOwner, required — Basic information about the owner of the ad-hoc user. - `userId` UserId, required — User identifier - `id` string, uuid, required - `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. - `roles` RoleConfig[] - `roleType` 'COMPANY_ADMIN' | 'COMPANY_TRAVEL_ARRANGER' | 'TRAVEL_ARRANGER' | 'COMPANY_REPORT_ADMIN' | 'TMC_ADMIN' | 'TMC_AGENT' | 'GLOBAL_ADMIN' | 'GLOBAL_AGENT' - `roleMetadata` RoleMeta - `travelArrangerMetadata` TravelArrangerMetadata - `arrangerFor` TravelerConfigForArranger[], required - `userId` string, uuid - `sendConfirmationEmail` boolean — Whether or not to send confirmation emails to user. - `sendFlightStatsNotificationEmail` boolean — Whether or not to send flight stat notifications to user. - `metadata` union - object - `roleType` string, required — Discriminator property for role metadata. - `arrangerFor` TravelerConfigForArranger[], required - `userId` string, uuid - `sendConfirmationEmail` boolean — Whether or not to send confirmation emails to user. - `sendFlightStatsNotificationEmail` boolean — Whether or not to send flight stat notifications to user. - object - `companyRef` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `tmcRef` Reference — Reference of an entity - `id` string, uuid, required - `name` string - `roleType` string, required — Role type for which company reference metadata is specified. - object - `tmcRef` Reference, required — Reference of an entity - `id` string, uuid, required - `name` string - `roleType` string, required — Role type for which tmc reference metadata is specified. ## Response `200` OK - CreateEventResponse — Response for create event - `id` string, required — Id of the created event - `userId` UserId — User identifier - `id` string, uuid, required ## Other responses - `400` — Bad request - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/spotnana/apis/event-api.md) · [All operations](https://skmtc.net/spotnana/apis/event-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/event-api/revisions/13f531f73066/schema)