Event API (v2)

Download OpenAPI specification:Download

Events

APIs to create and manage events.

Create event

Create a draft event.

SecurityBearer

Request

Request Body schema: application/json

name required	string Name of the event
description	string Description of the event
	Array of objects (Document) Documents attached for an event
	object (DateTimeLocal) Local date and time represented in the ISO 8601 standard.
	object (DateTimeLocal) Local date and time represented in the ISO 8601 standard.
required	object (EventLocation) Location for an event
	Array of objects (UserId) Contacts for the event
	Array of AirBookingGuidelineWrapper (object) or HotelBookingGuidelineWrapper (object) or CarBookingGuidelineWrapper (object) or RailBookingGuidelineWrapper (object) (EventBookingGuideline) A list of booking guideline for the event.
allowedBookingTypes	Array of strings (EventAllowedBookingType) Allowed booking types for the event group Items Enum: "AIR" "HOTEL" "CAR" "RAIL"
externalId	string External Id for the event
	Array of objects (CustomFieldResponse) List of custom field responses for the event.
parentEventId	string Optional parent event's id.
	object (CompanyId) Company id

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"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"
},
"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"
}
},
"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"
}
],
"parentEventId": "56789012",
"companyId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
}
}

Response samples

application/json

{"id": "string"
}

Get event

Get event details for the specified event ID.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/{eventId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"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
}
},
"allowedFlightGuidelines": [{"allowedFlightType": null,
"numberOfLegs": null
}
]
}
}
],
"metadata": {"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"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": 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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
}
]
},
"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"
}
}

Delete a draft event

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

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/events/{eventId}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

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.

SecurityBearer

Request

query Parameters

externalId required	string External ID Example: externalId=6926658168
companyId required	string <uuid> Company ID Example: companyId=f49d00fe-1eda-4304-ba79-a980f565281d

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/read-by-external-id

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"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
}
},
"allowedFlightGuidelines": [{"allowedFlightType": null,
"numberOfLegs": null
}
]
}
}
],
"metadata": {"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"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": 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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
}
]
},
"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"
}
}

Add travelers to an event

Add the list of travelers to be invited to the event.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

Array of objects (UserId)

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/add

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Response samples

application/json

{"addedUserIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Remove travelers from an event

Remove travelers from an event. This endpoint allows you to remove up to 10 travelers per API call.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

Array of objects (UserId) [ 1 .. 10 ] items

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/remove

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Response samples

application/json

{"removedUserIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

List events

List all the events that match the specified criteria in the request.

SecurityBearer

Request

Request Body schema: application/json

listEventType	string Type of events Enum: "UPCOMING" "PAST_OR_COMPLETED" "CANCELLED_EVENT"
	Array of EventUserFilterWrapper (object) or EventStatusFilterWrapper (object) or EventNameFilterWrapper (object) or EventDateRangeFilterWrapper (object) or EventCompanyFilterWrapper (object) or EventParentFilterWrapper (object) or EventTypeFilterWrapper (object) (EventFilter) List events filters
offset	integer >= 0 Default: 0 Indicates from where in the list of events the server should start.
limit	integer <= 100 Default: 10 Maximum number of results to be fetched for the query.

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/list

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"listEventType": "UPCOMING",
"filters": [{"userFilter": {"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
}
],
"offset": 2,
"limit": 2
}

Response samples

application/json

{"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
},
"allowedFlightGuidelines": [null
]
}
}
],
"metadata": {"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"documents": [{"url": "https://s3.amazonaws.com/bucket-name/folder-name/file-name",
"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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
}
]
},
"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
}
}

Publish event

Publish a draft event.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/publish

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "string"
}

Edit basic details of an event

Edit the basic information of an event such as the event name, description, date and time, location, and contacts.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

name required	string Name of the event
description	string Description of the event
	Array of objects (Document) Documents attached for an event
	object (DateTimeLocal) Local date and time represented in the ISO 8601 standard.
	object (DateTimeLocal) Local date and time represented in the ISO 8601 standard.
required	object (EventLocation) Location for an event
	Array of objects (UserId) Contacts for the event

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/edit-basic-info

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"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"
},
"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"
}
]
}

Response samples

application/json

{"id": "string"
}

Update event booking guidelines

Update the booking guidelines for an event. You can update booking guidelines such as maximum number of guests allowed to accompany a traveler, arrival and departure window for the event, payment methods, and allowed travel types.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

required	Array of AirBookingGuidelineWrapper (object) or HotelBookingGuidelineWrapper (object) or CarBookingGuidelineWrapper (object) or RailBookingGuidelineWrapper (object) (EventBookingGuideline) A list of booking guideline for the event.
allowedBookingTypes	Array of strings (EventAllowedBookingType) Allowed booking types for the event group Items Enum: "AIR" "HOTEL" "CAR" "RAIL"
	Array of objects (PaymentAccessMapping) Mappings i.e. access level, travel type information etc.

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/edit-booking-guidelines

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"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"
}
},
"allowedFlightGuidelines": [{"allowedFlightType": "ROUND_TRIP",
"numberOfLegs": 2
}
]
}
}
],
"allowedBookingTypes": ["AIR"
],
"paymentMappings": [{"id": "f49d00fe-1eda-4304-ba79-a980f565281d",
"accessTypeAttributes": {"travelTypeFilter": {"travelTypes": [{"travelType": "AIR",
"isRequired": true,
"allowPostPaidBookings": false,
"metadata": {"travelType": null,
"vendors": [ ]
}
}
]
}
}
}
]
}

Response samples

application/json

{"id": "string"
}

Set traveler RSVP

Update the RSVP status and the RSVP response for a traveler.

SecurityBearer

Request

path Parameters

eventId required	string Event ID Example: 6926658168
travelerId required	string <uuid> Traveler User ID Example: f49d00fe-1eda-4304-ba79-a980f565281d

Request Body schema: application/json

eventRsvpState	string (EventRsvpState) Allowed event rsvp states for a user Enum: "ADDED" "INVITED" "INVITE_ACCEPTED" "INVITE_DECLINED" "REMOVED"
	object (EventRsvpResponse) Event rsvp response

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/{travelerId}/rsvp

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"eventRsvpState": "ADDED",
"eventRsvpResponse": {"air": {"notNeeded": true
},
"hotel": {"notNeeded": true
},
"car": {"notNeeded": true
},
"rail": {"notNeeded": true
}
}
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get traveler RSVP

Get the RSVP status and the RSVP response for a traveler.

SecurityBearer

Request

path Parameters

eventId required	string Event ID Example: 6926658168
travelerId required	string <uuid> Traveler User ID Example: f49d00fe-1eda-4304-ba79-a980f565281d

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

get/v2/events/{eventId}/travelers/{travelerId}/rsvp

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
}

Send invite

Send event invites to the travelers via email. The invites can be sent to all travelers using a single API call, or you can send invites to specific travelers.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

Array of objects (UserId)

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/invite/send

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"userIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Send a test invite

Send a test event invite to the API caller. This endpoint can be used to preview the invite before sending it to the travelers.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/invite/test

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get event summaries

View summaries of specific events. This endpoint retrieves a list of traveler event summaries based on specified userId, companyId, and tripIds.

SecurityBearer

Request

Request Body schema: application/json

	object (UserId) User id
	object (CompanyId) Company id
tripIds	Array of strings List of Spotnana trip IDs

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/summaries

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"userId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"companyId": {"id": "f49d00fe-1eda-4304-ba79-a980f565281d"
},
"tripIds": ["6926658168"
]
}

Response samples

application/json

{"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": [{"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": null,
"invoiceMetadata": { },
"travelType": null
},
"name": "BoardingPass.pdf"
}
}
],
"bookingGuidelines": [{"numGuestsAllowed": 1,
"airBookingGuideLine": {"allowedAirports": [null
],
"arrivalBookingWindow": {"startDateTime": null,
"endDateTime": null
},
"departureBookingWindow": {"startDateTime": null,
"endDateTime": null
},
"allowedFlightGuidelines": [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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
},
"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
}
}
]
}

Get allowed payment sources

Get the payment sources that are associated with the userId of the event coordinator.

SecurityBearer

Request

query Parameters

userId

required

string <uuid>

ID of the event coordinator

Example: userId=f49d00fe-1eda-4304-ba79-a980f565281d

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/payment-sources

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"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"
}
]
}

Cancel event

Cancel a published event. After you've canceled the event, it's recommended that you cancel the bookings using the Cancel PNR API.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Responses

200

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/v2/events/{eventId}/cancel

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}

Get travelers list

Get a paginated list of travelers for an event, including each traveler's RSVP status, RSVP response, and tripId.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

offset	integer >= 0 Default: 0 Indicates from where in the list of travelers the server should start.
limit	integer [ 0 .. 100 ] Default: 10 Maximum number of results to be fetched for the query.
	Array of objects (EventTravelerFilter) Filters for event travelers

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers-list

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"offset": 2,
"limit": 2,
"filters": [{"type": "string",
"searchTerm": "name"
}
]
}

Response samples

application/json

{"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"
},
"airBookingStatus": "BOOKED",
"railBookingStatus": "BOOKED",
"carBookingStatus": "BOOKED",
"hotelBookingStatus": "BOOKED"
}
}
],
"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
}
}

Update event custom field responses

Update the response to a custom field question.

SecurityBearer

Request

path Parameters

eventId

required

string

Event ID

Example: 6926658168

Request Body schema: application/json

required

Array of objects (CustomFieldResponse)

List of custom field responses for an event.

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

put/v2/events/{eventId}/custom-field-responses

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"eventCustomFieldResponses": [{"customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
"responseItems": [{"response": "Leisure travel",
"additionalInput": "20"
}
],
"travelerAccess": "HIDDEN"
}
]
}

Response samples

application/json

{"debugIdentifier": "string",
"errorMessages": [{"errorCode": "string",
"message": "string",
"errorParameters": [{"name": "string",
"value": "string"
}
],
"errorDetail": "string"
}
]
}