Download OpenAPI specification:Download
This endpoint creates an event.
OK
Bad request
Unauthorized
Forbidden
{- "name": "string",
- "description": "string",
- "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": "VISA",
- "entityType": "PNR",
- "entityId": "123124",
- "entityMetadata": {
- "pnrMetadata": {
- "flightMetadata": {
- "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
}
}, - "invoiceMetadata": {
- "invoiceNumber": "SPOT-0001"
}, - "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"
}
], - "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"
}
}
}
}
], - "allowedBookingTypes": [
- "AIR"
], - "externalId": "qwert123",
- "eventCustomFieldResponses": [
- {
- "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "responseItems": [
- {
- "response": "Leisure travel",
- "additionalInput": "20"
}
], - "travelerAccess": "HIDDEN"
}
], - "parentEventId": "56789012",
- "companyId": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
}
{- "id": "string"
}
This endpoint gets event details for a given event ID.
OK
Unauthorized
Forbidden
The specified resource was not found.
{- "event": {
- "id": "string",
- "name": "string",
- "description": "string",
- "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
}
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "string",
- "description": "string",
- "bookingGuidelines": [
- {
- "numGuestsAllowed": 1,
- "airBookingGuideLine": {
- "allowedAirports": [
- {
- "airportCode": null,
- "airportName": null,
- "cityName": null,
- "countryName": null,
- "countryCode": null,
- "zoneName": null,
- "stateCode": null
}
], - "arrivalBookingWindow": {
- "startDateTime": {
- "iso8601": null
}, - "endDateTime": {
- "iso8601": null
}
}, - "departureBookingWindow": {
- "startDateTime": {
- "iso8601": null
}, - "endDateTime": {
- "iso8601": null
}
}
}
}
], - "metadata": {
- "contacts": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": "VISA",
- "entityType": "PNR",
- "entityId": "123124",
- "entityMetadata": {
- "pnrMetadata": null,
- "invoiceMetadata": { },
- "travelType": null
}, - "name": "BoardingPass.pdf"
}
}
]
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "Sample group name",
- "userGroupInfo": {
- "userGroupCriteria": [
- {
- "userIds": [
- null
], - "legalEntityIds": [
- null
], - "officeIds": [
- null
], - "departments": [
- null
], - "costCenters": [
- null
], - "grades": [
- null
], - "positionTitles": [
- null
], - "personas": [
- null
], - "customFieldIds": [
- null
], - "countryCodes": [
- null
], - "workerTypes": [
- null
], - "accountingCodes": [
- null
]
}
], - "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}, - "userTripInfos": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "tripInfos": [
- {
- "tripId": null,
- "status": null
}
]
}
], - "ownerId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "status": "PENDING_STATUS",
- "startDate": {
- "iso8601": "2017-07-21"
}, - "endDate": {
- "iso8601": "2017-07-21"
}, - "createdAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}, - "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "allowedBookingTypes": [
- "AIR"
], - "eventUserRsvpList": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}
]
}, - "status": "DRAFT",
- "companyId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "runningStatus": "UPCOMING",
- "paymentSources": [
- {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "type": "CARD",
- "paymentSource": {
- "cardDescriptor": {
- "card": {
- "id": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "type": "CREDIT",
- "company": "VISA",
- "name": "Harrison Schwartz",
- "address": {
- "addressLines": [ ],
- "administrativeArea": null,
- "administrativeAreaName": null,
- "description": null,
- "isDefault": null,
- "languageCode": null,
- "locality": null,
- "locationCode": null,
- "organization": null,
- "postalCode": null,
- "continentCode": null,
- "recipients": [ ],
- "regionCode": null,
- "regionName": null,
- "revision": null,
- "sortingCode": null,
- "sublocality": null,
- "timezone": null,
- "coordinates": null
}, - "number": "4111111111111111",
- "expiryMonth": 1,
- "expiryYear": 2010,
- "cvv": "012",
- "label": "Label amex",
- "currency": "USD",
- "externalId": "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40",
- "vaultId": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "expiry": {
- "tokenizedExpiry": null
}, - "ownershipLabel": "CENTRAL"
}, - "isCentrallyBilled": false,
- "isLodgeCard": false
}
}, - "mapping": {
- "accessType": "CENTRALISED",
- "accessTypeEntityId": "string",
- "filter": {
- "legalEntityFilter": {
- "legalEntityIds": [
- null
], - "companyId": {
- "id": null
}
}
}, - "travelType": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": null,
- "vendors": [ ]
}
}
], - "travelTypes": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": null,
- "vendors": [ ]
}
}
], - "spendTypes": [
- {
- "spendType": "SERVICE_FEE"
}
], - "paymentSourceAttributes": {
- "guestTravelAllowed": true,
- "roleTypes": [
- "TRAVEL_ARRANGER"
], - "includedPersonas": [
- "EMPLOYEE"
], - "excludedPersonas": [
- "EMPLOYEE"
], - "allowedThirdPartySources": [
- "SABRE"
]
}, - "accessTypeAttributes": {
- "travelTypeFilter": {
- "travelTypes": [
- null
]
}
}
}, - "status": "ACTIVE"
}
], - "numTravelers": 1,
- "customFieldResponses": [
- {
- "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "responseItems": [
- {
- "response": "Leisure travel",
- "additionalInput": "20"
}
], - "travelerAccess": "HIDDEN"
}
], - "externalId": "qwert123"
}
}
This endpoint deletes an event in draft state.
OK
Unauthorized
Forbidden
The specified resource was not found.
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}
This endpoint gets event details for a given event's external ID. External IDs are unique within an org.
OK
Unauthorized
Forbidden
The specified resource was not found.
{- "event": {
- "id": "string",
- "name": "string",
- "description": "string",
- "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
}
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "string",
- "description": "string",
- "bookingGuidelines": [
- {
- "numGuestsAllowed": 1,
- "airBookingGuideLine": {
- "allowedAirports": [
- {
- "airportCode": null,
- "airportName": null,
- "cityName": null,
- "countryName": null,
- "countryCode": null,
- "zoneName": null,
- "stateCode": null
}
], - "arrivalBookingWindow": {
- "startDateTime": {
- "iso8601": null
}, - "endDateTime": {
- "iso8601": null
}
}, - "departureBookingWindow": {
- "startDateTime": {
- "iso8601": null
}, - "endDateTime": {
- "iso8601": null
}
}
}
}
], - "metadata": {
- "contacts": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": "VISA",
- "entityType": "PNR",
- "entityId": "123124",
- "entityMetadata": {
- "pnrMetadata": null,
- "invoiceMetadata": { },
- "travelType": null
}, - "name": "BoardingPass.pdf"
}
}
]
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "Sample group name",
- "userGroupInfo": {
- "userGroupCriteria": [
- {
- "userIds": [
- null
], - "legalEntityIds": [
- null
], - "officeIds": [
- null
], - "departments": [
- null
], - "costCenters": [
- null
], - "grades": [
- null
], - "positionTitles": [
- null
], - "personas": [
- null
], - "customFieldIds": [
- null
], - "countryCodes": [
- null
], - "workerTypes": [
- null
], - "accountingCodes": [
- null
]
}
], - "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}, - "userTripInfos": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "tripInfos": [
- {
- "tripId": null,
- "status": null
}
]
}
], - "ownerId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "status": "PENDING_STATUS",
- "startDate": {
- "iso8601": "2017-07-21"
}, - "endDate": {
- "iso8601": "2017-07-21"
}, - "createdAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}, - "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "allowedBookingTypes": [
- "AIR"
], - "eventUserRsvpList": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}
]
}, - "status": "DRAFT",
- "companyId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "runningStatus": "UPCOMING",
- "paymentSources": [
- {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "type": "CARD",
- "paymentSource": {
- "cardDescriptor": {
- "card": {
- "id": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "type": "CREDIT",
- "company": "VISA",
- "name": "Harrison Schwartz",
- "address": {
- "addressLines": [ ],
- "administrativeArea": null,
- "administrativeAreaName": null,
- "description": null,
- "isDefault": null,
- "languageCode": null,
- "locality": null,
- "locationCode": null,
- "organization": null,
- "postalCode": null,
- "continentCode": null,
- "recipients": [ ],
- "regionCode": null,
- "regionName": null,
- "revision": null,
- "sortingCode": null,
- "sublocality": null,
- "timezone": null,
- "coordinates": null
}, - "number": "4111111111111111",
- "expiryMonth": 1,
- "expiryYear": 2010,
- "cvv": "012",
- "label": "Label amex",
- "currency": "USD",
- "externalId": "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40",
- "vaultId": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "expiry": {
- "tokenizedExpiry": null
}, - "ownershipLabel": "CENTRAL"
}, - "isCentrallyBilled": false,
- "isLodgeCard": false
}
}, - "mapping": {
- "accessType": "CENTRALISED",
- "accessTypeEntityId": "string",
- "filter": {
- "legalEntityFilter": {
- "legalEntityIds": [
- null
], - "companyId": {
- "id": null
}
}
}, - "travelType": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": null,
- "vendors": [ ]
}
}
], - "travelTypes": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": null,
- "vendors": [ ]
}
}
], - "spendTypes": [
- {
- "spendType": "SERVICE_FEE"
}
], - "paymentSourceAttributes": {
- "guestTravelAllowed": true,
- "roleTypes": [
- "TRAVEL_ARRANGER"
], - "includedPersonas": [
- "EMPLOYEE"
], - "excludedPersonas": [
- "EMPLOYEE"
], - "allowedThirdPartySources": [
- "SABRE"
]
}, - "accessTypeAttributes": {
- "travelTypeFilter": {
- "travelTypes": [
- null
]
}
}
}, - "status": "ACTIVE"
}
], - "numTravelers": 1,
- "customFieldResponses": [
- {
- "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "responseItems": [
- {
- "response": "Leisure travel",
- "additionalInput": "20"
}
], - "travelerAccess": "HIDDEN"
}
], - "externalId": "qwert123"
}
}
This endpoint adds travelers to an event.
OK
Bad request
Unauthorized
Forbidden
{- "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
{- "addedUserIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
This endpoint removes travelers from an event.
OK
Bad request
Unauthorized
Forbidden
{- "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
{- "removedUserIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
This endpoint lists events.
OK
Bad request
Unauthorized
Forbidden
{- "listEventType": "UPCOMING",
- "filters": [
- {
- "userFilter": {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
}
], - "offset": 2,
- "limit": 2
}
{- "events": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "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
}
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "string",
- "description": "string",
- "bookingGuidelines": [
- {
- "numGuestsAllowed": 1,
- "airBookingGuideLine": {
- "allowedAirports": [
- null
], - "arrivalBookingWindow": {
- "startDateTime": null,
- "endDateTime": null
}, - "departureBookingWindow": {
- "startDateTime": null,
- "endDateTime": null
}
}
}
], - "metadata": {
- "contacts": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": null,
- "entityType": null,
- "entityId": null,
- "entityMetadata": null,
- "name": null
}
}
]
}, - "group": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "name": "Sample group name",
- "userGroupInfo": {
- "userGroupCriteria": [
- {
- "userIds": [ ],
- "legalEntityIds": [ ],
- "officeIds": [ ],
- "departments": [ ],
- "costCenters": [ ],
- "grades": [ ],
- "positionTitles": [ ],
- "personas": [ ],
- "customFieldIds": [ ],
- "countryCodes": [ ],
- "workerTypes": [ ],
- "accountingCodes": [ ]
}
], - "userIds": [
- {
- "id": null
}
]
}, - "userTripInfos": [
- {
- "userId": {
- "id": null
}, - "tripInfos": [
- null
]
}
], - "ownerId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "status": "PENDING_STATUS",
- "startDate": {
- "iso8601": "2017-07-21"
}, - "endDate": {
- "iso8601": "2017-07-21"
}, - "createdAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}, - "createdBy": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "allowedBookingTypes": [
- "AIR"
], - "eventUserRsvpList": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": null
}, - "hotel": {
- "notNeeded": null
}, - "car": {
- "notNeeded": null
}, - "rail": {
- "notNeeded": null
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}
]
}, - "status": "DRAFT",
- "companyId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "runningStatus": "UPCOMING",
- "paymentSources": [
- {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "type": "CARD",
- "paymentSource": {
- "cardDescriptor": {
- "card": {
- "id": null,
- "type": null,
- "company": null,
- "name": null,
- "address": null,
- "number": null,
- "expiryMonth": null,
- "expiryYear": null,
- "cvv": null,
- "label": null,
- "currency": null,
- "externalId": null,
- "vaultId": null,
- "expiry": null,
- "ownershipLabel": null
}, - "isCentrallyBilled": false,
- "isLodgeCard": false
}
}, - "mapping": {
- "accessType": "CENTRALISED",
- "accessTypeEntityId": "string",
- "filter": {
- "legalEntityFilter": {
- "legalEntityIds": [ ],
- "companyId": null
}
}, - "travelType": [
- {
- "travelType": null,
- "isRequired": null,
- "allowPostPaidBookings": null,
- "metadata": null
}
], - "travelTypes": [
- {
- "travelType": null,
- "isRequired": null,
- "allowPostPaidBookings": null,
- "metadata": null
}
], - "spendTypes": [
- {
- "spendType": null
}
], - "paymentSourceAttributes": {
- "guestTravelAllowed": true,
- "roleTypes": [
- null
], - "includedPersonas": [
- null
], - "excludedPersonas": [
- null
], - "allowedThirdPartySources": [
- null
]
}, - "accessTypeAttributes": {
- "travelTypeFilter": {
- "travelTypes": [ ]
}
}
}, - "status": "ACTIVE"
}
], - "numTravelers": 1,
- "customFieldResponses": [
- {
- "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "responseItems": [
- {
- "response": "Leisure travel",
- "additionalInput": "20"
}
], - "travelerAccess": "HIDDEN"
}
], - "externalId": "qwert123"
}
], - "paginationParams": {
- "totalNumResults": 0
}
}
This endpoint allows updating basic event information.
OK
Bad request
Unauthorized
Forbidden
{- "name": "string",
- "description": "string",
- "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": "VISA",
- "entityType": "PNR",
- "entityId": "123124",
- "entityMetadata": {
- "pnrMetadata": {
- "flightMetadata": {
- "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
}
}, - "invoiceMetadata": {
- "invoiceNumber": "SPOT-0001"
}, - "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"
}
]
}
{- "id": "string"
}
This endpoint updates the booking guidelines for an event.
OK
Bad request
Unauthorized
Forbidden
{- "bookingGuidelines": [
- {
- "numGuestsAllowed": 1,
- "airBookingGuideLine": {
- "allowedAirports": [
- {
- "airportCode": "WRA",
- "airportName": "Warder Airport",
- "cityName": "Werder",
- "countryName": "Ethiopia",
- "countryCode": "ET",
- "zoneName": "Africa/Addis_Ababa",
- "stateCode": "CA"
}
], - "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"
}
}
}
}
], - "allowedBookingTypes": [
- "AIR"
], - "paymentMappings": [
- {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "accessTypeAttributes": {
- "travelTypeFilter": {
- "travelTypes": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": null,
- "vendors": [ ]
}
}
]
}
}
}
]
}
{- "id": "string"
}
This endpoint sets traveler's rsvp and response for the event.
OK
Bad request
Unauthorized
Forbidden
{- "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}
}
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}
This endpoint gets traveler's rsvp and response for the event.
OK
Bad request
Unauthorized
Forbidden
{- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}
This endpoint sends invite to all or some travellers of an event.
OK
Bad request
Unauthorized
Forbidden
{- "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}
This endpoint tests an invite for an event.
OK
Bad request
Unauthorized
Forbidden
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}
This endpoint gets event summaries
OK
Bad request
Unauthorized
Forbidden
{- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "companyId": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}, - "tripIds": [
- "6926658168"
]
}
{- "tripEventSummaries": [
- {
- "tripId": "6926658168",
- "travelerEventSummary": {
- "id": "12345",
- "name": "My event",
- "description": "This is an event description",
- "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"
}
], - "documents": [
- {
- "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "documentMetadata": {
- "documentType": "VISA",
- "entityType": "PNR",
- "entityId": "123124",
- "entityMetadata": {
- "pnrMetadata": null,
- "invoiceMetadata": { },
- "travelType": null
}, - "name": "BoardingPass.pdf"
}
}
], - "bookingGuidelines": [
- {
- "numGuestsAllowed": 1,
- "airBookingGuideLine": {
- "allowedAirports": [
- null
], - "arrivalBookingWindow": {
- "startDateTime": null,
- "endDateTime": null
}, - "departureBookingWindow": {
- "startDateTime": null,
- "endDateTime": null
}
}
}
], - "allowedBookingTypes": [
- "AIR"
], - "eventUserRsvp": {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}, - "contactInfoList": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "email": "a@spotnana.com",
- "name": {
- "family1": "Gandas",
- "family2": "FamilyTwo",
- "given": "Vichitr",
- "middle": "Kumar",
- "suffix": "SR",
- "preferred": "Don"
}
}
], - "companyId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "runningStatus": "UPCOMING",
- "status": "DRAFT",
- "isRemovedParticipant": true
}
}
]
}
This endpoint gets the list of payment sources that can be used for Events.
OK
Unauthorized
Forbidden
The specified resource was not found.
{- "paymentSources": [
- {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "type": "CARD",
- "paymentSource": {
- "cardDescriptor": {
- "card": {
- "id": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "type": "CREDIT",
- "company": "VISA",
- "name": "Harrison Schwartz",
- "address": {
- "addressLines": [
- null
], - "administrativeArea": "CA",
- "administrativeAreaName": "California",
- "description": "San Francisco Home",
- "isDefault": true,
- "languageCode": "en",
- "locality": "San Francisco",
- "locationCode": "LAX",
- "organization": "Spotnana",
- "postalCode": "94130",
- "continentCode": "AF",
- "recipients": [
- null
], - "regionCode": "US",
- "regionName": "America",
- "revision": 1,
- "sortingCode": "Jamaica",
- "sublocality": "string",
- "timezone": "America/Los_Angeles",
- "coordinates": {
- "latitude": null,
- "longitude": null
}
}, - "number": "4111111111111111",
- "expiryMonth": 1,
- "expiryYear": 2010,
- "cvv": "012",
- "label": "Label amex",
- "currency": "USD",
- "externalId": "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40",
- "vaultId": "34d536b6-f8ff-11eb-9a61-0242ac180002",
- "expiry": {
- "tokenizedExpiry": {
- "expiryMonth": null,
- "expiryYear": null
}
}, - "ownershipLabel": "CENTRAL"
}, - "isCentrallyBilled": false,
- "isLodgeCard": false
}
}, - "mapping": {
- "accessType": "CENTRALISED",
- "accessTypeEntityId": "string",
- "filter": {
- "legalEntityFilter": {
- "legalEntityIds": [
- {
- "id": null
}
], - "companyId": {
- "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
}
}, - "travelType": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": "string",
- "vendors": [
- null
]
}
}
], - "travelTypes": [
- {
- "travelType": "AIR",
- "isRequired": true,
- "allowPostPaidBookings": false,
- "metadata": {
- "travelType": "string",
- "vendors": [
- null
]
}
}
], - "spendTypes": [
- {
- "spendType": "SERVICE_FEE"
}
], - "paymentSourceAttributes": {
- "guestTravelAllowed": true,
- "roleTypes": [
- "TRAVEL_ARRANGER"
], - "includedPersonas": [
- "EMPLOYEE"
], - "excludedPersonas": [
- "EMPLOYEE"
], - "allowedThirdPartySources": [
- "SABRE"
]
}, - "accessTypeAttributes": {
- "travelTypeFilter": {
- "travelTypes": [
- {
- "travelType": null,
- "isRequired": null,
- "allowPostPaidBookings": null,
- "metadata": null
}
]
}
}
}, - "status": "ACTIVE"
}
]
}
This endpoint cancels a published event.
OK
Unauthorized
Forbidden
The specified resource was not found.
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}
This endpoint retrieves the paginated list of travelers of a specific event.
OK
Bad request
Unauthorized
Forbidden
{- "offset": 2,
- "limit": 2,
- "filters": [
- {
- "type": "string",
- "searchTerm": "name"
}
]
}
{- "travelerEventInfos": [
- {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "tripInfos": [
- {
- "tripId": "1234567890",
- "status": "PENDING_STATUS"
}
], - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "eventUserRsvp": {
- "userId": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "eventRsvpState": "ADDED",
- "eventRsvpResponse": {
- "air": {
- "notNeeded": true
}, - "hotel": {
- "notNeeded": true
}, - "car": {
- "notNeeded": true
}, - "rail": {
- "notNeeded": true
}
}, - "invitedAt": {
- "iso8601": "2017-07-21T17:32Z"
}
}
}
], - "userGroupInfo": {
- "userGroupCriteria": [
- {
- "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "legalEntityIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "officeIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "departments": [
- "string"
], - "costCenters": [
- "string"
], - "grades": [
- "string"
], - "positionTitles": [
- "string"
], - "personas": [
- "EMPLOYEE"
], - "customFieldIds": [
- {
- "type": "QUESTION",
- "externalId": "string"
}
], - "countryCodes": [
- "GB"
], - "workerTypes": [
- "EMPLOYEE"
], - "accountingCodes": [
- "string"
]
}
], - "userIds": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}, - "paginationParams": {
- "totalNumResults": 0
}
}
This endpoint updates the event's custom field responses.
OK
Bad request
Unauthorized
Forbidden
{- "eventCustomFieldResponses": [
- {
- "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
- "responseItems": [
- {
- "response": "Leisure travel",
- "additionalInput": "20"
}
], - "travelerAccess": "HIDDEN"
}
]
}
{- "debugIdentifier": "string",
- "errorMessages": [
- {
- "errorCode": "string",
- "message": "string",
- "errorParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "errorDetail": "string"
}
]
}