Skip to content

Event API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/eventapi

Events

APIs to create and manage events.

Operations

Create event

Request

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.

Security
Bearer
Bodyapplication/json
namestringrequired

Name of the event

descriptionstring

Description of the event

documentsArray of objects(Document)

Documents attached for an event

startDateTimeobject(DateTimeLocal)

Local date and time in ISO 8601 format.

endDateTimeobject(DateTimeLocal)

Local date and time in ISO 8601 format.

locationobject(EventLocation)required

Location for an event

location.​addressobject(PostalAddress)

Postal Address Details

location.​coordinatesobject(Latlng)

Latitude and Longitude for a Location

contactsArray of objects(UserId)

Contacts for the event

bookingGuidelinesArray of AirBookingGuidelineWrapper (object) or HotelBookingGuidelineWrapper (object) or CarBookingGuidelineWrapper (object) or RailBookingGuidelineWrapper (object)(EventBookingGuideline)

A list of booking guideline for the event.

allowedBookingTypesArray of strings(EventAllowedBookingType)

Allowed booking types for the event group

Items Enum"AIR""HOTEL""CAR""RAIL"
externalIdstring

External Id for the event

Example: "qwert123"
eventCustomFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

parentEventIdstring

Optional parent event's id.

Example: "56789012"
companyIdobject(CompanyId)

Company id

bookingStylestring(EventBookingStyle)

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"
referenceUsersArray of objects(UserId)

Event group reference user ids

travelerTypesArray of strings(Persona)

Allowed traveler types for the event

Items Enum"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"
Example: ["EMPLOYEE"]
policyIdstring(uuid)

Policy associated with the event.

Example: "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
travellersArray of objects(UserId)[ 0 .. 1000 ] items

Travellers associated with the event

typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
allowTravelersPolicystring(AllowTravelersPolicy)

Apply travelers policy when it is less restrictive.

Enum"ALLOWED""NOT_ALLOWED"
emailPreferencesobject(BucketEmailPreferences)

Email communication preferences based on bucket types.

internalNotesstring

Internal notes of the event

Example: "Use travelers default as payment method."
allowTravelersToRsvpstring(AllowTravelersToRsvp)

Allow travelers to rsvp for the event

Enum"ALLOWED""NOT_ALLOWED"
tripOverridesobject(TripOverrides)

Trip overrides for the event

tripContactsArray of objects(TripContact)

Trip contacts for the event. These are passed through to created trips.

inheritedCustomFieldIdsArray of strings(uuid)

List of custom field IDs that were inherited from parent

Example: ["f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"]
inviteEmailConfigobject(InviteEmailConfig)

Configuration for event invite/reminder emails

useHiddenTemplateboolean

When true, the backend resolves the active hidden template for the company and uses it as the parent event. Mutually exclusive with parentEventId.

Default false
newTravelerobject(UserCreateRequest)

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.

eventCustomFieldResponsesArray of objects(CustomFieldResponse)Deprecated

List of custom field responses for the event.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "documents": [
      {
        "url": "https://s3.amazonaws.com/bucket-name/folder-name/file-name",
        "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "documentMetadata": {
          "documentType": "VISA",
          "entityType": "PNR",
          "entityId": "123124",
          "entityMetadata": {
            "pnrMetadata": {
              "flightMetadata": {
                "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
              }
            },
            "invoiceMetadata": {
              "invoiceNumber": "SPOT-0001",
              "invoiceType": "FARE_INVOICE"
            },
            "travelType": "AIR"
          },
          "name": "BoardingPass.pdf"
        }
      }
    ],
    "startDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "endDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "location": {
      "address": {
        "addressLines": [
          "Golden Gate Bridge"
        ],
        "administrativeArea": "CA",
        "administrativeAreaName": "California",
        "description": "San Francisco Home",
        "isDefault": true,
        "languageCode": "en",
        "locality": "San Francisco",
        "locationCode": "LAX",
        "organization": "Spotnana",
        "postalCode": "94130",
        "continentCode": "AF",
        "recipients": [
          "string"
        ],
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "sublocality": "string",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      },
      "coordinates": {
        "latitude": 77.1025,
        "longitude": 28.7041
      }
    },
    "contacts": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "bookingGuidelines": [
      {
        "numGuestsAllowed": 1,
        "airBookingGuideLine": {
          "allowedAirports": [
            {
              "airportCode": "WRA",
              "airportName": "Warder Airport",
              "cityName": "Werder",
              "countryName": "Ethiopia",
              "countryCode": "ET",
              "zoneName": "Africa/Addis_Ababa",
              "stateCode": "CA"
            }
          ],
          "allowedCityCodes": [
            "NYC"
          ],
          "arrivalBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "departureBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "allowedFlightGuidelines": [
            {
              "allowedFlightType": "ROUND_TRIP",
              "numberOfLegs": 2
            }
          ]
        }
      }
    ],
    "allowedBookingTypes": [
      "AIR"
    ],
    "externalId": "qwert123",
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "eventCustomFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "readOnly": true,
        "hidden": true,
        "selectedOptions": [
          {
            "name": "string",
            "translatedName": "string",
            "description": "string",
            "translatedDescription": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ],
    "parentEventId": "56789012",
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "bookingStyle": "SELF_SERVE",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "travelerTypes": [
      "EMPLOYEE"
    ],
    "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "travellers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "type": "GENERIC",
    "allowTravelersPolicy": "ALLOWED",
    "emailPreferences": {
      "bucketTypes": [
        "BOOKING_CONFIRMATIONS"
      ],
      "isEnabled": false,
      "toEmails": [
        "example@email.com"
      ],
      "ccEmails": [
        "example@email.com"
      ],
      "bccEmails": [
        "example@email.com"
      ]
    },
    "internalNotes": "Use travelers default as payment method.",
    "allowTravelersToRsvp": "ALLOWED",
    "tripOverrides": {
      "legalEntity": {
        "behavior": "OVERRIDE_ALLOWED",
        "legalEntityRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "costCenter": {
        "behavior": "OVERRIDE_ALLOWED",
        "costCenterRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "department": {
        "behavior": "OVERRIDE_ALLOWED",
        "departmentRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "userAttributes": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "attribute": {
            "fixedColumnName": "contingentType",
            "value": "FSTV"
          }
        }
      ],
      "rateCodeOverrides": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "supplier": "SABRE",
          "travelType": "AIR",
          "rateCodeIds": [
            "f49d00fe-1eda-4304-ba79-a980f565281d"
          ]
        }
      ]
    },
    "tripContacts": [
      {
        "label": "Coordinator",
        "name": "Himani Jain",
        "email": "himani@spotnana.com",
        "phoneNumber": {
          "countryCode": 91,
          "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
          "extension": "222",
          "isoCountryCode": "IN",
          "italianLeadingZero": true,
          "nationalNumber": 8150,
          "numberOfLeadingZeros": 1,
          "preferredDomesticCarrierCode": "7",
          "rawInput": "77777",
          "type": "MOBILE"
        },
        "isPrimary": true,
        "restrictVisibility": true
      }
    ],
    "inheritedCustomFieldIds": [
      "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
    ],
    "inviteEmailConfig": {
      "emailExcludeCoordinatorInfo": true
    },
    "useHiddenTemplate": false,
    "newTraveler": {
      "personalInfo": {
        "addresses": [
          {
            "addressLines": [
              "Golden Gate Bridge"
            ],
            "administrativeArea": "CA",
            "administrativeAreaName": "California",
            "description": "San Francisco Home",
            "isDefault": true,
            "languageCode": "en",
            "locality": "San Francisco",
            "locationCode": "LAX",
            "organization": "Spotnana",
            "postalCode": "94130",
            "continentCode": "AF",
            "recipients": [
              "string"
            ],
            "regionCode": "US",
            "regionName": "America",
            "revision": 1,
            "sortingCode": "Jamaica",
            "sublocality": "string",
            "timezone": "America/Los_Angeles",
            "coordinates": {
              "latitude": 77.1025,
              "longitude": 28.7041
            }
          }
        ],
        "dob": {
          "iso8601": "2017-07-21"
        },
        "email": "example@email.com",
        "emergencyContactInfo": {
          "address": {
            "addressLines": [
              "Golden Gate Bridge"
            ],
            "administrativeArea": "CA",
            "administrativeAreaName": "California",
            "description": "San Francisco Home",
            "isDefault": true,
            "languageCode": "en",
            "locality": "San Francisco",
            "locationCode": "LAX",
            "organization": "Spotnana",
            "postalCode": "94130",
            "continentCode": "AF",
            "recipients": [
              "string"
            ],
            "regionCode": "US",
            "regionName": "America",
            "revision": 1,
            "sortingCode": "Jamaica",
            "sublocality": "string",
            "timezone": "America/Los_Angeles",
            "coordinates": {
              "latitude": 77.1025,
              "longitude": 28.7041
            }
          },
          "designation": "MANAGER",
          "email": "emergency-contact@email.com",
          "name": {
            "family1": "Gandas",
            "family2": "FamilyTwo",
            "given": "Vichitr",
            "middle": "Kumar",
            "suffix": "SR",
            "preferred": "Don"
          },
          "phoneNumber": {
            "countryCode": 91,
            "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
            "extension": "222",
            "isoCountryCode": "IN",
            "italianLeadingZero": true,
            "nationalNumber": 8150,
            "numberOfLeadingZeros": 1,
            "preferredDomesticCarrierCode": "7",
            "rawInput": "77777",
            "type": "MOBILE"
          },
          "userOrgId": {
            "organizationAgencyId": {
              "id": "string"
            },
            "organizationId": {
              "id": "string"
            },
            "userId": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            },
            "tmcInfo": {
              "id": {
                "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
              },
              "primaryServiceProviderTmc": {
                "tmcId": {}
              },
              "secondaryServiceProviderTmcs": [
                {}
              ],
              "partnerTmcId": {
                "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
              }
            },
            "tmcBasicInfo": {
              "contractingTmc": {
                "id": {},
                "name": "string",
                "logo": {}
              },
              "bookingTmc": {
                "id": {},
                "name": "string",
                "logo": {}
              }
            }
          }
        },
        "gender": "FEMALE",
        "identityDocs": [
          {
            "passport": {
              "docId": "PASSPORTID",
              "expiryDate": {
                "iso8601": "2017-07-21"
              },
              "issueCountry": "IN",
              "issuedDate": {
                "iso8601": "2017-07-21"
              },
              "nationalityCountry": "IN",
              "type": "REGULAR"
            }
          },
          {
            "ktn": {
              "number": "123456",
              "issueCountry": "US"
            }
          }
        ],
        "name": {
          "family1": "Gandas",
          "family2": "FamilyTwo",
          "given": "Vichitr",
          "middle": "Kumar",
          "suffix": "SR",
          "preferred": "Don"
        },
        "phoneNumbers": [
          {
            "countryCode": 91,
            "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
            "extension": "222",
            "isoCountryCode": "IN",
            "italianLeadingZero": true,
            "nationalNumber": 8150,
            "numberOfLeadingZeros": 1,
            "preferredDomesticCarrierCode": "7",
            "rawInput": "77777",
            "type": "MOBILE"
          }
        ],
        "profilePicture": {
          "data": "6935813e12584abda0e43d71cd2ea260",
          "dimensions": {
            "height": 120,
            "width": 240
          },
          "url": "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"
        },
        "nationality": "Indian",
        "title": "MR",
        "preferredLanguage": "en-US",
        "preferredPronoun": "SHE_HER_HERS",
        "travelerName": {
          "family1": "Gandas",
          "family2": "FamilyTwo",
          "given": "Vichitr",
          "middle": "Kumar",
          "suffix": "SR",
          "preferred": "Don"
        },
        "emergencyContact": {
          "name": "John Smith",
          "email": "emergency-contact@email.com",
          "designation": "MANAGER",
          "relation": "SPOUSE",
          "phoneNumbers": [
            {
              "countryCode": 91,
              "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
              "extension": "222",
              "isoCountryCode": "IN",
              "italianLeadingZero": true,
              "nationalNumber": 8150,
              "numberOfLeadingZeros": 1,
              "preferredDomesticCarrierCode": "7",
              "rawInput": "77777",
              "type": "MOBILE"
            }
          ],
          "preferredLanguage": "en-US"
        }
      },
      "businessInfo": {
        "departmentRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "designation": "MANAGER",
        "email": "user@business.com",
        "employeeId": "101",
        "gradeRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "legalEntityRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "managerRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "officeRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "organizationRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "phoneNumbers": [
          {
            "countryCode": 91,
            "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
            "extension": "222",
            "isoCountryCode": "IN",
            "italianLeadingZero": true,
            "nationalNumber": 8150,
            "numberOfLeadingZeros": 1,
            "preferredDomesticCarrierCode": "7",
            "rawInput": "77777",
            "type": "MOBILE"
          }
        ],
        "costCenterRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "countryCode": "USA",
        "workerType": "EMPLOYEE",
        "accountingCode": "123",
        "companySpecifiedAttributes": [
          {
            "fixedColumnName": "contingentType",
            "value": "FSTV"
          }
        ],
        "designatedApproverRefs": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
            "name": "Name"
          }
        ],
        "authorizerEmail": "example@email.com"
      },
      "persona": "EMPLOYEE",
      "relativeOf": {
        "userRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "relation": "SPOUSE"
      },
      "billingCurrency": "INR",
      "tier": "SEAT1A",
      "stealthType": "STEALTH_TYPE_1",
      "externalId": "string",
      "travelPreferences": {
        "preferences": {
          "airPref": {
            "airlinePrefs": [
              {
                "airlines": [
                  null
                ],
                "flightType": "DOMESTIC"
              }
            ],
            "alliancePref": {
              "alliances": [
                "STAR_ALLIANCE"
              ]
            },
            "farePref": {
              "fareTypes": [
                "CHANGEABLE"
              ]
            },
            "homeAirport": "NEW YORK",
            "mealPref": {
              "exclMealPrefs": [
                "VGML"
              ],
              "inclMealPrefs": [
                "VGML"
              ],
              "specialMealDescription": "Veg only meal"
            },
            "numStopPref": {
              "numOfStops": 34
            },
            "seatAmenityPref": {
              "seatAmenityTypes": [
                "WIFI"
              ]
            },
            "seatLocationPrefs": [
              {
                "cabins": [
                  null
                ],
                "isBulkHeadPref": false,
                "maxFlightDurationInHours": 3,
                "position": "WINDOW"
              }
            ],
            "preferredAirports": [
              {
                "airportName": "San Francisco International Airport",
                "airportCode": "SFO",
                "label": "HOME"
              }
            ]
          },
          "preferredCurrency": "USD",
          "railCards": [
            {
              "cardNumber": "string",
              "expiryDate": {
                "iso8601": "2017-07-21"
              },
              "name": "Veterans Railcard",
              "spotnanaCode": "VET",
              "vendor": "ATOC"
            }
          ],
          "railPref": {
            "preferredRailStations": [
              {
                "stationName": "Chicago Union Station",
                "stationCode": "CHI",
                "cityName": "Chicago",
                "countryCode": "string",
                "label": "HOME"
              }
            ],
            "seatPreference": {
              "hasAccessibility": false,
              "seatTypes": [
                "NORMAL"
              ],
              "seatLocations": [
                "AISLE"
              ],
              "deckLevels": [
                "UPPER_DECK"
              ],
              "seatDirections": [
                "FORWARD"
              ]
            },
            "travelClasses": [
              "FIRST"
            ],
            "coachPreferences": [
              "NON_SMOKING"
            ],
            "conditionalRates": [
              "AAA"
            ]
          },
          "carPref": {
            "vendors": [
              {
                "code": "ZE",
                "name": "HERTZ",
                "isPresentInPreferredVendors": true
              }
            ],
            "carTypes": [
              "ECONOMY"
            ],
            "engineTypes": [
              "PETROL"
            ],
            "transmissionTypes": [
              "AUTOMATIC"
            ],
            "conditionalRates": [
              "AAA"
            ]
          },
          "hotelPref": {
            "hotelParentChains": [
              {
                "chainCode": "EM",
                "chainName": "Mariott"
              }
            ],
            "hotelBrands": [
              {
                "brandCode": "HY",
                "brandName": "Global Hytt Corp."
              }
            ],
            "hotelAmenityTypes": [
              "PARKING"
            ],
            "roomPreference": {
              "isMobilityAccessible": false,
              "bedCount": "ONE_BED",
              "roomType": "SMOKING",
              "mostImportantFact": "BED_COUNT",
              "roomLocation": "HIGH_FLOOR",
              "pillowType": "FOAM",
              "roomAmenityPrefs": [
                "EXTRA_TOWELS"
              ]
            },
            "conditionalRates": [
              "AAA"
            ]
          }
        }
      },
      "membershipInfo": {
        "membershipInfos": [
          {
            "appliedTo": [
              "TAJ"
            ],
            "id": "firstId",
            "issuedBy": "firstIssuedBy",
            "type": "AIR",
            "linked": false
          }
        ],
        "isLoyaltyBlocked": false
      },
      "notificationPreferences": {
        "preferences": [
          {
            "notificationType": "FLIGHT_NOTIFICATION",
            "emailPreference": {
              "enabled": true,
              "ccEmails": [
                "user@example.com"
              ]
            }
          }
        ]
      },
      "travelArrangers": {
        "travelArrangers": [
          {
            "name": {
              "family1": "Gandas",
              "family2": "FamilyTwo",
              "given": "Vichitr",
              "middle": "Kumar",
              "suffix": "SR",
              "preferred": "Don"
            },
            "email": "example@email.com",
            "phoneNumbers": [
              {
                "countryCode": 91,
                "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
                "extension": "222",
                "isoCountryCode": "IN",
                "italianLeadingZero": true,
                "nationalNumber": 8150,
                "numberOfLeadingZeros": 1,
                "preferredDomesticCarrierCode": "7",
                "rawInput": "77777",
                "type": "MOBILE"
              }
            ],
            "userId": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            },
            "status": "PENDING"
          }
        ]
      },
      "adhocUserInfo": {
        "profileOwner": {
          "userId": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        },
        "isSaved": false
      },
      "roles": [
        {
          "roleType": "COMPANY_ADMIN",
          "roleMetadata": {
            "travelArrangerMetadata": {
              "arrangerFor": [
                {}
              ]
            }
          },
          "metadata": {
            "roleType": "TRAVEL_ARRANGER",
            "arrangerFor": [
              {
                "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
                "sendConfirmationEmail": false,
                "sendFlightStatsNotificationEmail": false
              }
            ]
          }
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
idstringrequired

Id of the created event

userIdobject(UserId)

Id of the newly created user, if a new traveler was created

Response
application/json
{ "id": "string", "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

Get event

Request

Get event details for the specified event ID.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Query
typestring(EventType)

EventType of the event.

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
Example: type=GENERIC
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168?type=GENERIC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
eventobject(Event)

Event details

Response
application/json
{ "event": { "id": "string", "name": "string", "type": "GENERIC", "description": "string", "startDateTime": {}, "endDateTime": {}, "location": {}, "group": {}, "status": "DRAFT", "companyId": {}, "runningStatus": "UPCOMING", "paymentSources": [], "numTravelers": 1, "customFieldResponses": [], "customFieldV3Responses": [], "externalId": "qwert123", "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b", "parentEventId": "56789012", "isDetached": true, "aggregateStartDateTime": {}, "aggregateEndDateTime": {}, "childEventCounts": {} } }

Delete a draft event

Request

Delete a draft (i.e., unpublished) event. A deleted event cannot be accessed or viewed again.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
curl -i -X DELETE \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content