Sign in

v1

latestOpenAPI 3.1.02026-08-0624411242.2 KB
Events

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.

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

Request body

namestring required

Name of the event

type'GENERIC' | 'PROGRAM' | 'PROGRAM_SESSION' | 'PROGRAM_TRIP'

Type of an event

descriptionstring

Description of the event

travelerTypesPersona[]

Allowed traveler types for the event

bookingStyle'SELF_SERVE' | 'AGENT_MANAGED'

The booking style for the event's participants.

policyIdstring uuid

Policy associated with the event.

allowTravelersPolicy'ALLOWED' | 'NOT_ALLOWED'

Apply travelers policy when it is less restrictive.

allowTravelersToRsvp'ALLOWED' | 'NOT_ALLOWED'

Allow travelers to rsvp for the event

internalNotesstring

Internal notes of the event

inheritedCustomFieldIdsstring[]

List of custom field IDs that were inherited from parent

Example request

{
  "type": "GENERIC",
  "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",
            "invoiceType": "FARE_INVOICE"
          },
          "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",
      "regionCode": "US",
      "regionName": "America",
      "revision": 1,
      "sortingCode": "Jamaica",
      "timezone": "America/Los_Angeles",
      "coordinates": {
        "latitude": 77.1025,
        "longitude": 28.7041
      }
    },
    "coordinates": {
      "latitude": 77.1025,
      "longitude": 28.7041
    }
  },
  "travelerTypes": [
    "EMPLOYEE"
  ],
  "bookingStyle": "SELF_SERVE",
  "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
  "emailPreferences": {
    "bucketTypes": [
      "BOOKING_CONFIRMATIONS"
    ],
    "toEmails": [
      "example@email.com"
    ],
    "ccEmails": [
      "example@email.com"
    ],
    "bccEmails": [
      "example@email.com"
    ]
  },
  "internalNotes": "Use travelers default as payment method.",
  "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
    }
  ],
  "inheritedCustomFieldIds": [
    "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
  ],
  "eventCustomFieldV3Responses": [
    {
      "readOnly": true,
      "hidden": true,
      "selectedOptions": [
        {
          "additionalInfoConfigs": [
            {
              "type": "VARIABLE",
              "name": "LLF"
            }
          ]
        }
      ]
    }
  ],
  "eventCustomFieldResponses": [
    {
      "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
      "responseItems": [
        {
          "response": "Leisure travel",
          "additionalInput": "20"
        }
      ],
      "travelerAccess": "HIDDEN"
    }
  ],
  "inviteEmailConfig": {
    "emailExcludeCoordinatorInfo": true
  }
}

Response

OK

idstring