Event Templates

API reference

/Event Templates

Event Templates

APIs to create and manage event templates.

Operations

Create an event template

Request

This endpoint creates an event template.

Security

Bearer

Bodyapplication/json

namestringrequired

Name of the event template

descriptionstring

Description of the event

locationobject(EventLocation)

Location for an event

allowedBookingTypesArray of strings

Allowed booking types for the event template

bookingGuidelinesArray of objects(EventBookingGuideline)

A list of booking guideline for the event.

customFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

paymentMappingsArray of objects(PaymentAccessMapping)

Mappings i.e. access level, travel type information etc.

companyIdobject(CompanyId)required

Company id

internalNotesstring

Internal notes of the event

Example:"Use travelers default as payment method."

referenceUsersArray of objects(UserId)

Event group reference user ids

travelerTypesArray of strings, non-emptyrequired

Allowed traveler types for the event

policyIdstring, (uuid)

Policy associated with the event.

Example:"f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

bookingStylestring(EventBookingStyle)required

Whether the event bookings will be self served by the traveler or would be arranged by an agent for the traveler.

Enum:"SELF_SERVE""AGENT_MANAGED"

Example:"SELF_SERVE"

externalIdstring

External Id for the event

Example:"qwert123"

allowTravelersPolicystring(AllowTravelersPolicy)

Apply travelers policy when it is less restrictive.

Enum:"ALLOWED""NOT_ALLOWED"

emailPreferencesobject(BucketEmailPreferences)

Email communication preferences based on bucket types.

allowTravelersToRsvpstring(AllowTravelersToRsvp)

Allow travelers to rsvp for the event

Enum:"ALLOWED""NOT_ALLOWED"

tripOverridesobject(TripOverrides)

Trip overrides for the event

tripContactsArray of objects(TripContact)

Trip contacts for the event. These are passed through to created trips.

inviteEmailConfigobject(InviteEmailConfig)

Configuration for event invite/reminder emails

customFieldResponsesArray of objects(CustomFieldResponse)deprecated

Preselected custom field responses for the event template.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/event-templates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "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
      }
    },
    "allowedBookingTypes": [
      "AIR"
    ],
    "bookingGuidelines": [
      {
        "numGuestsAllowed": 1,
        "airBookingGuideLine": {
          "allowedAirports": [
            {
              "airportCode": "WRA",
              "airportName": "Warder Airport",
              "cityName": "Werder",
              "countryName": "Ethiopia",
              "countryCode": "ET",
              "zoneName": "Africa/Addis_Ababa",
              "stateCode": "CA"
            }
          ],
          "allowedCityCodes": [
            "NYC"
          ],
          "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
            }
          ]
        }
      }
    ],
    "customFieldResponses": [
      {
        "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",
            "translatedName": "string",
            "description": "string",
            "translatedDescription": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ],
            "optionId": "dee15a0e-f1fe-4cd8-88ac-c090810707f8"
          }
        ]
      }
    ],
    "paymentMappings": [
      {
        "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "accessTypeAttributes": {
          "travelTypeFilter": {
            "travelTypes": [
              {
                "travelType": "AIR",
                "isRequired": true,
                "allowPostPaidBookings": false,
                "metadata": {
                  "vendors": []
                }
              }
            ]
          }
        }
      }
    ],
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "internalNotes": "Use travelers default as payment method.",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "travelerTypes": [
      "EMPLOYEE"
    ],
    "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "bookingStyle": "SELF_SERVE",
    "externalId": "qwert123",
    "allowTravelersPolicy": "ALLOWED",
    "emailPreferences": {
      "bucketTypes": [
        "BOOKING_CONFIRMATIONS"
      ],
      "isEnabled": false,
      "toEmails": [
        "example@email.com"
      ],
      "ccEmails": [
        "example@email.com"
      ],
      "bccEmails": [
        "example@email.com"
      ]
    },
    "allowTravelersToRsvp": "ALLOWED",
    "tripOverrides": {
      "legalEntity": {
        "behavior": "OVERRIDE_ALLOWED",
        "legalEntityRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "costCenter": {
        "behavior": "OVERRIDE_ALLOWED",
        "costCenterRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "department": {
        "behavior": "OVERRIDE_ALLOWED",
        "departmentRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "userAttributes": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "attribute": {
            "fixedColumnName": "contingentType",
            "value": "FSTV"
          }
        }
      ],
      "rateCodeOverrides": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "supplier": "SABRE",
          "travelType": "AIR",
          "rateCodeIds": [
            "f49d00fe-1eda-4304-ba79-a980f565281d"
          ]
        }
      ]
    },
    "tripContacts": [
      {
        "label": "Coordinator",
        "name": "Himani Jain",
        "email": "himani@spotnana.com",
        "phoneNumber": {
          "countryCode": 91,
          "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
          "extension": "222",
          "isoCountryCode": "IN",
          "italianLeadingZero": true,
          "nationalNumber": 8150,
          "numberOfLeadingZeros": 1,
          "preferredDomesticCarrierCode": "7",
          "rawInput": "77777",
          "type": "MOBILE"
        },
        "isPrimary": true,
        "restrictVisibility": true
      }
    ],
    "inviteEmailConfig": {
      "emailExcludeCoordinatorInfo": true
    }
  }'

Responses

Bodyapplication/json

idstring

Response

{
  "id": "string"
}