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-docs.redocly.app/docs/_mock/openapi/eventapi

Events

APIs to create and manage events.

Operations

Bulk delete draft events

Request

API to bulk delete draft events.

Security
Bearer
Bodyapplication/jsonrequired
deleteEventListArray of objects(DeleteEventRequest)[ 1 .. 100 ] itemsrequired

List of events to be deleted.

deleteEventList[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
deleteEventList[].​typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/bulk-delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deleteEventList": [
      {
        "id": "56789012",
        "type": "GENERIC"
      }
    ]
  }'

Responses

Bulk delete response with event statuses

Bodyapplication/json
deleteEventResponsesArray of objects(DeleteEventResponse)required

List of events delete response.

deleteEventResponses[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
deleteEventResponses[].​statusstring(OperationStatus)required

Generic operation/execution status.

Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
deleteEventResponses[].​messagestring

Details about success or failure reason.

Example: "Deleted successfully"
Response
application/json
{ "deleteEventResponses": [ { … } ] }

Bulk cancel events

Request

API to bulk cancel events.

Security
Bearer
Bodyapplication/jsonrequired
cancelAsyncboolean

Flag to indicate if the cancellation should be processed asynchronously.

Default false
Example: false
cancelEventRequestsArray of objects(CancelEventRequest)[ 1 .. 100 ] itemsrequired

List of events to be cancelled.

cancelEventRequests[].​eventIdstringrequired

Unique identifier for the event.

Example: "56789012"
cancelEventRequests[].​typestring(EventType)required

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/bulk-cancel \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancelAsync": false,
    "cancelEventRequests": [
      {
        "eventId": "56789012",
        "type": "GENERIC"
      }
    ]
  }'

Responses

Bulk cancel response with event statuses

Bodyapplication/json
cancelEventResponsesArray of objects(CancelEventResponse)required

List of events cancellation response.

cancelEventResponses[].​eventIdstringrequired

Unique identifier for the event.

Example: "56789012"
cancelEventResponses[].​statusstring(OperationStatus)required

Generic operation/execution status.

Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
cancelEventResponses[].​messagestring

Details about success or failure reason.

Example: "Cancelled successfully"
Response
application/json
{ "cancelEventResponses": [ { … } ] }

Register for event

Request

Register a traveler for a PROGRAM_SESSION event. If userId is omitted, the logged-in user is registered. Creates a PROGRAM_TRIP child event under the session and publishes it, triggering async trip creation. Requires enableRegisterLink to be true on the session event. Returns the new PROGRAM_TRIP event ID.

Security
Bearer
Path
eventIdstringrequired

Event ID of the PROGRAM_SESSION event to register for.

Example: 6926658168
Bodyapplication/json
userIdstring

User ID of the traveler to register. When omitted, the logged-in user is registered (self-registration).

Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/register \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Responses

OK

Bodyapplication/json
eventIdstringrequired

ID of the newly created PROGRAM_TRIP event.

Example: "56789012"
tripIdstring

ID of the trip, if already created. Present when the user was already registered.

Example: "12345678"
Response
application/json
{ "eventId": "56789012", "tripId": "12345678" }