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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "documents": [
    ],
  • "startDateTime": {
    },
  • "endDateTime": {
    },
  • "location": {
    },
  • "contacts": [
    ],
  • "bookingGuidelines": [
    ],
  • "allowedBookingTypes": [
    ],
  • "externalId": "qwert123",
  • "eventCustomFieldResponses": [
    ],
  • "parentEventId": "56789012",
  • "companyId": {
    }
}
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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/{eventId}
Request samples
Response samples
application/json
{
  • "event": {
    }
}

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/v2/events/{eventId}
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/read-by-external-id
Request samples
Response samples
application/json
{
  • "event": {
    }
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/add
Request samples
application/json
{
  • "userIds": [
    ]
}
Response samples
application/json
{
  • "addedUserIds": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/remove
Request samples
application/json
{
  • "userIds": [
    ]
}
Response samples
application/json
{
  • "removedUserIds": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/list
Request samples
application/json
{
  • "listEventType": "UPCOMING",
  • "filters": [
    ],
  • "offset": 2,
  • "limit": 2
}
Response samples
application/json
{
  • "events": [
    ],
  • "paginationParams": {
    }
}

Publish event

Publish a draft event.

SecurityBearer
Request
path Parameters
eventId
required
string

Event ID

Example: 6926658168
Responses
200

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/publish
Request samples
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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/edit-basic-info
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "documents": [
    ],
  • "startDateTime": {
    },
  • "endDateTime": {
    },
  • "location": {
    },
  • "contacts": [
    ]
}
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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/edit-booking-guidelines
Request samples
application/json
{
  • "bookingGuidelines": [
    ],
  • "allowedBookingTypes": [
    ],
  • "paymentMappings": [
    ]
}
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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers/{travelerId}/rsvp
Request samples
application/json
{
  • "eventRsvpState": "ADDED",
  • "eventRsvpResponse": {
    }
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

get/v2/events/{eventId}/travelers/{travelerId}/rsvp
Request samples
Response samples
application/json
{
  • "userId": {
    },
  • "eventRsvpState": "ADDED",
  • "eventRsvpResponse": {
    },
  • "invitedAt": {
    },
  • "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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/invite/send
Request samples
application/json
{
  • "userIds": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/invite/test
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/summaries
Request samples
application/json
{
  • "userId": {
    },
  • "companyId": {
    },
  • "tripIds": [
    ]
}
Response samples
application/json
{
  • "tripEventSummaries": [
    ]
}

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/events/payment-sources
Request samples
Response samples
application/json
{
  • "paymentSources": [
    ]
}

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

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/v2/events/{eventId}/cancel
Request samples
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/events/{eventId}/travelers-list
Request samples
application/json
{
  • "offset": 2,
  • "limit": 2,
  • "filters": [
    ]
}
Response samples
application/json
{
  • "travelerEventInfos": [
    ],
  • "userGroupInfo": {
    },
  • "paginationParams": {
    }
}

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

OK

400

Bad request

401

Unauthorized

403

Forbidden

put/v2/events/{eventId}/custom-field-responses
Request samples
application/json
{
  • "eventCustomFieldResponses": [
    ]
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}
Copyright © 2020-2024 Spotnana Technology, Inc.