# Get event by external ID

Get event details using the event's externalId. External IDs are unique identifiers which can be set based on the company's preference.

Endpoint: GET /v2/events/read-by-external-id
Version: v2
Security: Bearer

## Query parameters:

  - `externalId` (string, required)
    External ID
    Example: "6926658168"

  - `companyId` (string, required)
    Company ID
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

## Response 200 fields (application/json):

  - `event` (object)
    Event details

  - `event.id` (string)
    Event ID

  - `event.name` (string)
    Name of the event

  - `event.type` (string)
    Event Type
    Enum: "GENERIC", "PROGRAM", "PROGRAM_SESSION", "PROGRAM_TRIP"

  - `event.description` (string)
    Description of the event

  - `event.startDateTime` (object)
    Local date and time in ISO 8601 format.

  - `event.startDateTime.iso8601` (string, required)
    Example: "2017-07-21T17:32"

  - `event.endDateTime` (object)
    Local date and time in ISO 8601 format.

  - `event.location` (object)
    Location for an event

  - `event.location.address` (object)
    Postal Address Details

  - `event.location.address.addressLines` (array, required)
    Address lines
    Example: ["Golden Gate Bridge"]

  - `event.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"

  - `event.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"

  - `event.location.address.description` (string)
    Address description
    Example: "San Francisco Home"

  - `event.location.address.isDefault` (boolean)
    Whether this address is default address in case multiple addresses are specified.
    Example: true

  - `event.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"

  - `event.location.address.locality` (string)
    Generally refers to the city/town portion of the address.
    Example: "San Francisco"

  - `event.location.address.locationCode` (string)
    IATA 3-letter location code. See https://www.iata.org/en/services/codes.
    Example: "LAX"

  - `event.location.address.organization` (string)
    The name of the organization at the address.
    Example: "Spotnana"

  - `event.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"

  - `event.location.address.continentCode` (string)
    2 letter continent code of the continent this address falls in.
    Example: "AF"

  - `event.location.address.recipients` (array)
    The recipient at the address.

  - `event.location.address.regionCode` (string, required)
    Region code of the country/region of the address.
    Example: "US"

  - `event.location.address.regionName` (string)
    Region name of the country/region of the address.
    Example: "America"

  - `event.location.address.revision` (integer)
    Example: 1

  - `event.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"

  - `event.location.address.sublocality` (string)
    Sublocality of the address. This can be neighborhoods, boroughs, districts.

  - `event.location.address.timezone` (string)
    Time zone of the address.
    Example: "America/Los_Angeles"

  - `event.location.address.coordinates` (object)
    Map coordinates of the address.

  - `event.location.address.coordinates.latitude` (number, required)
    Latitude of the Location
    Example: 77.1025

  - `event.location.address.coordinates.longitude` (number, required)
    Longitude of the Location
    Example: 28.7041

  - `event.location.coordinates` (object)
    Latitude and Longitude for a Location

  - `event.group` (object)
    Group of users for the event

  - `event.group.id` (string)
    Event Group ID
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `event.group.name` (string)
    Name of the event group

  - `event.group.description` (string)
    Description of the event group

  - `event.group.bookingGuidelines` (array)
    A list of BookingGuideline for event group

  - `event.group.metadata` (object)
    Metadata for event group

  - `event.group.metadata.contacts` (array)
    Event group contacts

  - `event.group.metadata.contacts.id` (string, required)

  - `event.group.metadata.documents` (array)
    Documents attached for an event group

  - `event.group.metadata.documents.url` (string, required)
    S3 location of the document.
    Example: "https://s3.amazonaws.com/bucket-name/folder-name/file-name"

  - `event.group.metadata.documents.documentId` (string, required)
    Unique identifier of the document.
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `event.group.metadata.documents.documentMetadata` (object, required)
    Metadata related to document.

  - `event.group.metadata.documents.documentMetadata.documentType` (string, required)
    Document type.
    Enum: "BOARDING_PASS", "CONFIRMATION", "INVOICE", "VISA", "MISCELLANEOUS", "OTHERS", "TASK_PROCESSOR", "EVENT_COVER_IMAGE", "LOGO_IMAGE"

  - `event.group.metadata.documents.documentMetadata.entityType` (string, required)
    Entity type against which the document is to uploaded.
    Enum: "PNR", "COMPANY", "AIR_ITINERARY", "EVENT", "LOCATION_IMAGE"

  - `event.group.metadata.documents.documentMetadata.entityId` (string, required)
    Entity Id for the given entity type.
    Example: "123124"

  - `event.group.metadata.documents.documentMetadata.entityMetadata` (any, required)

  - `event.group.metadata.documents.documentMetadata.name` (string, required)
    Document name.
    Example: "BoardingPass.pdf"

  - `event.group.metadata.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"

  - `event.group.metadata.referenceUsers` (array)
    Event group reference user ids

  - `event.group.metadata.internalNotes` (string)
    Internal notes of the event

  - `event.group.metadata.travelerTypes` (array)
    Allowed traveler types for the event
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `event.group.metadata.allowTravelersPolicy` (string)
    Apply travelers policy when it is less restrictive.
    Enum: "ALLOWED", "NOT_ALLOWED"

  - `event.group.metadata.emailPreferences` (object)
    Email communication preferences based on bucket types.

  - `event.group.metadata.emailPreferences.bucketTypes` (array, required)
    List of email bucket types.
    Enum: "BOOKING_CONFIRMATIONS", "BOOKING_CHANGES", "FLIGHT_UPDATES", "APPROVAL_REQUESTS", "APPROVAL_UPDATES", "REMINDERS", "INVOICE_UPDATES"

  - `event.group.metadata.emailPreferences.isEnabled` (boolean)
    Indicates whether emails are disabled.

  - `event.group.metadata.emailPreferences.toEmails` (array)
    List of email address to be included in emails.
    Example: ["example@email.com"]

  - `event.group.metadata.emailPreferences.ccEmails` (array)
    List of email address to be cc-ed in emails.
    Example: ["example@email.com"]

  - `event.group.metadata.emailPreferences.bccEmails` (array)
    List of email address to be bcc-ed in emails.
    Example: ["example@email.com"]

  - `event.group.metadata.allowTravelersToRsvp` (string)
    Allow travelers to rsvp for the event
    Enum: "ALLOWED", "NOT_ALLOWED"

  - `event.group.metadata.tripOverrides` (object)
    Trip overrides for the event

  - `event.group.metadata.tripOverrides.legalEntity` (object, required)
    Legal entity override

  - `event.group.metadata.tripOverrides.legalEntity.behavior` (string, required)
    Override behavior for the trip overrides
    Enum: "OVERRIDE_ALLOWED", "OVERRIDE_NOT_ALLOWED", "OVERRIDE_MANDATORY"

  - `event.group.metadata.tripOverrides.legalEntity.legalEntityRef` (object)
    Reference of an entity

  - `event.group.metadata.tripOverrides.legalEntity.legalEntityRef.name` (string)
    Example: "Name"

  - `event.group.metadata.tripOverrides.costCenter` (object, required)
    Cost center override

  - `event.group.metadata.tripOverrides.costCenter.costCenterRef` (object)
    Reference of an entity

  - `event.group.metadata.tripOverrides.department` (object, required)
    Department override

  - `event.group.metadata.tripOverrides.department.departmentRef` (object)
    Reference of an entity

  - `event.group.metadata.tripOverrides.userAttributes` (array, required)
    List of company specified attribute overrides

  - `event.group.metadata.tripOverrides.userAttributes.attribute` (object, required)
    Company specified user arbitrary attribute.

  - `event.group.metadata.tripOverrides.userAttributes.attribute.fixedColumnName` (string, required)
    Example: "contingentType"

  - `event.group.metadata.tripOverrides.userAttributes.attribute.value` (string)
    Example: "FSTV"

  - `event.group.metadata.tripOverrides.rateCodeOverrides` (array)
    List of rate codes to be overridden for a trip

  - `event.group.metadata.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"

  - `event.group.metadata.tripOverrides.rateCodeOverrides.travelType` (string)
    Travel Type
    Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL"

  - `event.group.metadata.tripOverrides.rateCodeOverrides.rateCodeIds` (array)
    List of rate code ids
    Example: ["f49d00fe-1eda-4304-ba79-a980f565281d"]

  - `event.group.metadata.inheritedCustomFieldIds` (array)
    List of custom field IDs that were inherited from parent
    Example: ["f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"]

  - `event.group.metadata.inviteEmailConfig` (object)
    Configuration for event invite/reminder emails

  - `event.group.metadata.inviteEmailConfig.emailExcludeCoordinatorInfo` (boolean)
    Whether to exclude coordinator information in emails sent to travelers.
    Example: true

  - `event.group.group` (object)
    Definition of a group to combine users and their trips.

  - `event.group.group.id` (string)
    ID of the group.
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `event.group.group.name` (string)
    Name of the group.
    Example: "Sample group name"

  - `event.group.group.userGroupInfo` (object)
    Details about group's users.

  - `event.group.group.userGroupInfo.userGroupCriteria` (array)
    User group criteria

  - `event.group.group.userGroupInfo.userGroupCriteria.userIds` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.legalEntityIds` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.officeIds` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.departments` (array)
    List of department ids.

  - `event.group.group.userGroupInfo.userGroupCriteria.costCenters` (array)
    List of cost center ids.

  - `event.group.group.userGroupInfo.userGroupCriteria.grades` (array)
    List of grade ids.

  - `event.group.group.userGroupInfo.userGroupCriteria.positionTitles` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.personas` (array)
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `event.group.group.userGroupInfo.userGroupCriteria.countryCodes` (array)
    Example: ["GB"]

  - `event.group.group.userGroupInfo.userGroupCriteria.workerTypes` (array)
    Enum: "EMPLOYEE", "CONTINGENT", "SEASONAL", "INTERN", "GUEST"

  - `event.group.group.userGroupInfo.userGroupCriteria.accountingCodes` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.customFieldIds` (array)

  - `event.group.group.userGroupInfo.userGroupCriteria.customFieldIds.type` (string, required)
    The type of custom field.
    Enum: "QUESTION", "MEETING", "BUDGET", "BREX_TOKEN"

  - `event.group.group.userGroupInfo.userGroupCriteria.customFieldIds.externalId` (string, required)
    Meeting id or budget id based on custom field type.

  - `event.group.group.userGroupInfo.userIds` (array)
    List of users derived from the user group criteria

  - `event.group.group.userTripInfos` (array)
    Details of the users and their trips in the group.

  - `event.group.group.userTripInfos.userId` (object, required)
    User identifier

  - `event.group.group.userTripInfos.tripInfos` (array)
    List of trips for the user.

  - `event.group.group.userTripInfos.tripInfos.tripId` (string, required)
    ID of the trip of the user.
    Example: "1234567890"

  - `event.group.group.userTripInfos.tripInfos.status` (string, required)
    User facing booking status
    Enum: "UNKNOWN_STATUS", "PENDING_STATUS", "CONFIRMED_STATUS", "ACTIVE_STATUS", "COMPLETED_STATUS", "CANCELLED_STATUS", "REFUNDED_STATUS", "VOIDED_STATUS", "PROCESSING_STATUS", "UNCONFIRMED_STATUS", "AIRLINE_CONTROL_STATUS", "PAYMENT_DECLINED_STATUS", "SCHEDULE_CHANGE_STATUS", "HOLD_STATUS", "APPROVAL_REQUESTED_STATUS", "APPROVAL_DENIED_STATUS", "CANCELLATION_IN_PROGRESS_STATUS", "INOPERATIVE_STATUS", "FLIGHT_UNCONFIRMED_STATUS"

  - `event.group.group.ownerId` (object, required)
    User identifier

  - `event.group.group.startDate` (object)
    Date in ISO 8601 standard.

  - `event.group.group.endDate` (object)
    Date in ISO 8601 standard.

  - `event.group.group.createdAt` (object)
    ISO8601 UTC Date Time

  - `event.group.createdBy` (object)
    User identifier

  - `event.group.allowedBookingTypes` (array)
    Allowed booking types for the event group
    Enum: "AIR", "HOTEL", "CAR", "RAIL"

  - `event.group.eventUserRsvpList` (array)
    List of user rsvp responses for the event group

  - `event.group.eventUserRsvpList.eventRsvpState` (string)
    Allowed event rsvp states for a user
    Enum: "ADDED", "INVITED", "INVITE_ACCEPTED", "INVITE_DECLINED", "REMOVED"

  - `event.group.eventUserRsvpList.eventRsvpResponse` (object)
    Event rsvp response

  - `event.group.eventUserRsvpList.eventRsvpResponse.air` (object)
    Air rsvp response

  - `event.group.eventUserRsvpList.eventRsvpResponse.air.notNeeded` (boolean)
    Whether air booking is needed by the traveler or not
    Example: true

  - `event.group.eventUserRsvpList.eventRsvpResponse.hotel` (object)
    Hotel rsvp response

  - `event.group.eventUserRsvpList.eventRsvpResponse.hotel.notNeeded` (boolean)
    Whether hotel booking is needed by the traveler or not
    Example: true

  - `event.group.eventUserRsvpList.eventRsvpResponse.car` (object)
    Car rsvp response

  - `event.group.eventUserRsvpList.eventRsvpResponse.car.notNeeded` (boolean)
    Whether car booking is needed by the traveler or not
    Example: true

  - `event.group.eventUserRsvpList.eventRsvpResponse.rail` (object)
    Rail rsvp response

  - `event.group.eventUserRsvpList.eventRsvpResponse.rail.notNeeded` (boolean)
    Whether rail booking is needed by the traveler or not
    Example: true

  - `event.group.eventUserRsvpList.invitedAt` (object)
    ISO8601 UTC Date Time

  - `event.group.eventUserRsvpList.airBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `event.group.eventUserRsvpList.railBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `event.group.eventUserRsvpList.carBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `event.group.eventUserRsvpList.hotelBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `event.group.allowedPaymentConfig` (array)
    Allowed payment configuration for the event template

  - `event.group.allowedPaymentConfig.paymentConfig` (string, required)
    Allowed payment configuration for a travel type in the event template
    Enum: "TRAVELER_DEFAULT", "PERSONAL", "SELECTED_METHODS"

  - `event.status` (string)
    Status of an event
    Enum: "DRAFT", "PUBLISH", "CANCELLED"

  - `event.companyId` (object)
    Identifier of an object

  - `event.runningStatus` (string)
    Running status of an event
    Enum: "IN_PROGRESS", "UPCOMING", "COMPLETED"

  - `event.paymentSources` (array)
    List of payment sources

  - `event.paymentSources.id` (string, required)
    Unique identifier identifying this payment source
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `event.paymentSources.type` (string)
    Type of Payment Source
    Enum: "CARD", "VIRTUAL_CARD", "REWARDS_PROGRAM", "DELAYED_INVOICING", "CUSTOM_PAYMENT_METHOD", "VENDOR_PROGRAM_PAYMENT", "UNUSED_CREDIT", "CASH"

  - `event.paymentSources.paymentSource` (any, required)

  - `event.paymentSources.status` (string)
    Status of the Payment Source.
    Enum: "ACTIVE", "INCOMPLETE", "TEMPORARY_READY", "TEMPORARY_USED", "TEMPORARY_EXPIRED", "TEMPORARY_INCOMPLETE"

  - `event.paymentSources.mapping` (object)
    Mapping i.e. access level, travel type information etc.

  - `event.paymentSources.mapping.accessType` (string)
    Access Type of the Payment Source
    Enum: "CENTRALISED", "PERSONAL", "APPLICATION", "TMC", "ITINERARY", "EVENT", "EVENT_TEMPLATE"

  - `event.paymentSources.mapping.accessTypeEntityId` (string)
    Entity ID corresponding to the Access Type being created

  - `event.paymentSources.mapping.filter` (any)

  - `event.paymentSources.mapping.travelTypes` (array)
    Applicable payment source travel types

  - `event.paymentSources.mapping.travelTypes.travelType` (string, required)
    Applicable travel segment type, e.g. AIR, HOTEL etc.
    Enum: "AIR", "HOTEL", "CAR", "RAIL", "LIMO", "MISC", "ALL"

  - `event.paymentSources.mapping.travelTypes.isRequired` (boolean)
    Whether this is a required payment source for this travel type.

  - `event.paymentSources.mapping.travelTypes.allowPostPaidBookings` (boolean)
    Whether post paid bookings are allowed for this travel type.

  - `event.paymentSources.mapping.travelTypes.metadata` (any)

  - `event.paymentSources.mapping.spendTypes` (array)
    Applicable spend types for payment source other than travel

  - `event.paymentSources.mapping.spendTypes.spendType` (string, required)
    Applicable spend type e.g SERVICE_FEE
    Enum: "SERVICE_FEE"

  - `event.paymentSources.mapping.paymentSourceAttributes` (object)
    Attributes applicable to the associated payment source.

  - `event.paymentSources.mapping.paymentSourceAttributes.roleTypes` (array)
    Role types which have access to the payment source
    Enum: "UNKNOWN_TYPE", "COMPANY_ADMIN", "COMPANY_TRAVEL_ARRANGER", "TRAVEL_ARRANGER", "COMPANY_REPORT_ADMIN", "GLOBAL_ADMIN", "GLOBAL_AGENT", "TMC_AGENT", "TMC_ADMIN"

  - `event.paymentSources.mapping.paymentSourceAttributes.includedPersonas` (array)
    If specified, list of traveler personas which have access to the payment source.
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `event.paymentSources.mapping.paymentSourceAttributes.excludedPersonas` (array)
    List of traveler personas which don't have access to the payment source.
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `event.paymentSources.mapping.paymentSourceAttributes.allowedThirdPartySources` (array)
    List of 3rd party sources supported for the payment source.
    Enum: "UNKNOWN_SOURCE", "SABRE", "TRAVEL_FUSION", "AVIA", "NDC", "TRAINLINE", "ATPCO_NDC", "FARELOGIX_NDC", "OFFLINE", "CONNEXUS", "ROUTEHAPPY", "AMADEUS", "GIATA", "QBR", "BCD", "QANTAS_HOTELS", "SOUTHWEST", "EXPEDIA", "HOTEL_HUB", "MARRIOTT", "CLEARTRIP", "KYTE", "GROUNDSPAN", "SABRE_NDC", "BOOKING_COM", "CARTRAWLER", "PREMIER_INN", "TRAVELODGE"

  - `event.paymentSources.mapping.paymentSourceAttributes.allowedTripTypes` (array)
    List of trip types supported for the payment source.
    Enum: "STANDARD", "EVENT"

  - `event.paymentSources.mapping.paymentSourceAttributes.priority` (integer)
    Priority of payment source used to order while listing payment sources. Priority is a positive number.
    Example: 2

  - `event.paymentSources.mapping.paymentSourceAttributes.guestTravelAllowed` (boolean)
    Whether guest travel is allowed.

  - `event.paymentSources.mapping.accessTypeAttributes` (object)
    Attributes applicable to the access type.

  - `event.paymentSources.mapping.accessTypeAttributes.travelTypeFilter` (object)
    Filter for selecting payment sources according to different types of travel.

  - `event.paymentSources.mapping.accessTypeAttributes.travelTypeFilter.travelTypes` (array)
    Applicable travel types for Payment Source.

  - `event.paymentSources.mapping.travelType` (array)
    Applicable payment source travel type.

  - `event.numTravelers` (integer)
    Number of active travelers in the event
    Example: 1

  - `event.customFieldV3Responses` (array)
    List of custom field responses for an event.

  - `event.customFieldV3Responses.fieldId` (string, required)
    Custom field id

  - `event.customFieldV3Responses.fieldName` (string)
    Name of the custom field

  - `event.customFieldV3Responses.armId` (string, required)
    Arm id which is applicable

  - `event.customFieldV3Responses.readOnly` (boolean)
    Indicates whether the user can change the pre-selected options.
    Example: true

  - `event.customFieldV3Responses.hidden` (boolean)
    Whether this code will be hidden to the user.
    Example: true

  - `event.customFieldV3Responses.selectedOptions` (array, required)
    The list of options that are selected by user or auto populated.

  - `event.customFieldV3Responses.selectedOptions.name` (string, required)
    Value of the selection

  - `event.customFieldV3Responses.selectedOptions.description` (string)
    Description of the selection

  - `event.customFieldV3Responses.selectedOptions.additionalUserInput` (string)
    Additional user input

  - `event.customFieldV3Responses.selectedOptions.additionalInfos` (array)
    Actual values of the additional infos

  - `event.customFieldV3Responses.selectedOptions.additionalInfoConfigs` (array)
    Additional info configs for the selected option

  - `event.externalId` (string)
    External Id for the event
    Example: "qwert123"

  - `event.policyId` (string)
    Policy associated with the event.
    Example: "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

  - `event.parentEventId` (string)
    Optional parent event's id.
    Example: "56789012"

  - `event.isDetached` (boolean)
    Whether the event is detached from the parent event or not.
    Example: true

  - `event.aggregateStartDateTime` (object)
    Aggregate start date time of the event, applicable for program session events.

  - `event.aggregateEndDateTime` (object)
    Aggregate end date time of the event, applicable for program session events.

  - `event.customFieldResponses` (array)
    Preselected custom field responses for the event.

  - `event.customFieldResponses.customFieldId` (string, required)
    The unique identifier for the custom field.
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `event.customFieldResponses.responseItems` (array)
    Responses selected by the event coordinator.

  - `event.customFieldResponses.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"

  - `event.customFieldResponses.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"

  - `event.customFieldResponses.travelerAccess` (string, required)
    Traveler access for the given custom field.
    Enum: "HIDDEN", "READ_ACCESS", "WRITE_ACCESS"

## 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.

## Response 404 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.