Skip to content
API reference
/
Events
/
/
Update event custom field...

Event API (v2)

Download OpenAPI description
EventApi.json
EventApi.yaml
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

Get travelers list

Request

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

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
offsetinteger>= 0

Indicates from where in the list of travelers the server should start.

Default 0
Example: 2
limitinteger[ 0 .. 100 ]

Maximum number of results to be fetched for the query.

Default 10
Example: 2
typestring(EventType)
Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
filtersArray of TravelerSearchFilter (object) or InvitationStatusFilter (object) or AirBookingStatusFilter (object) or RailBookingStatusFilter (object) or CarBookingStatusFilter (object) or HotelBookingStatusFilter (object)(EventTravelerFilter)

Filters for event travelers

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/travelers-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 2,
    "limit": 2,
    "type": "GENERIC",
    "filters": [
      {
        "type": "string",
        "searchTerm": "name"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
travelerEventInfosArray of objects(TravelerEventInfo)

List of user rsvp responses & trip details

userGroupInfoobject(UserGroupInfo)
paginationParamsobject(OffsetBasedPaginationResponseParams)
Response
application/json
{
  "travelerEventInfos": [
    { … }
  ],
  "userGroupInfo": {
    "userGroupCriteria": [ … ],
    "userIds": [ … ]
  },
  "paginationParams": {
    "totalNumResults": 0
  }
}

Update event custom field responses

Request

Update the response to a custom field question.

Security
Bearer
Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
customFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

eventCustomFieldResponsesArray of objects(CustomFieldResponse)Deprecated

List of custom field responses for an event.

curl -i -X PUT \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/6926658168/custom-field-responses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "customFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "readOnly": true,
        "hidden": true,
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ]
  }'

Responses

OK

Response
No content

Bulk publish events

Request

API to bulk publish events and has a support for sending invite to selective users

Security
Bearer
Bodyapplication/jsonrequired
publishEventListArray of objects(PublishEventRequest)[ 1 .. 100 ] itemsrequired

List of events to be published.

publishEventList[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
publishEventList[].​sendInvitebooleanrequired

Flag to indicate if an invite should be sent.

Example: true
publishEventList[].​userIdsArray of objects(UserId)[ 0 .. 1000 ] items

List of users receiving the invite. - If provided, invites will be sent only to the specified users. - If empty or not provided, invites will be sent to all users.

publishEventList[].​typestring(EventType)
Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/events/bulk-publish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "publishEventList": [
      {
        "id": "56789012",
        "sendInvite": true,
        "userIds": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        ],
        "type": "GENERIC"
      }
    ]
  }'

Responses

Bulk publish response with event statuses

Bodyapplication/json
publishEventResponsesArray of objects(PublishEventResponse)required

List of events publish response.

publishEventResponses[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
publishEventResponses[].​statusstring(OperationStatus)required
Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
publishEventResponses[].​messagestring

Details about success or failure reason.

Example: "Published successfully"
Response
application/json
{
  "publishEventResponses": [
    { … }
  ]
}
Copyright © 2025 Spotnana Technology, Inc.