Sign in
latestOpenAPI 3.1.02026-08-1824413243.2 KB

9f7a7c91278c

Events

Create event

Create a draft event. Optionally pass newTraveler to create a new traveler and add them to the event. If the traveler already exists, the request fails — use the travellers field with the existing userId.

post/v2/events

Request body

namestring required

Name of the event

descriptionstring

Description of the event

allowedBookingTypesEventAllowedBookingType[]

Allowed booking types for the event group

externalIdstring

External Id for the event

parentEventIdstring

Optional parent event's id.

bookingStyle'SELF_SERVE' | 'AGENT_MANAGED'

The booking style for the event's participants.

travelerTypesPersona[]

Allowed traveler types for the event

policyIdstring uuid

Policy associated with the event.

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

Type of an event

allowTravelersPolicy'ALLOWED' | 'NOT_ALLOWED'

Apply travelers policy when it is less restrictive.

internalNotesstring

Internal notes of the event

allowTravelersToRsvp'ALLOWED' | 'NOT_ALLOWED'

Allow travelers to rsvp for the event

inheritedCustomFieldIdsstring[]

List of custom field IDs that were inherited from parent

useHiddenTemplateboolean

When true, the backend resolves the active hidden template for the company and uses it as the parent event. Mutually exclusive with parentEventId.

Response

OK

idstring required

Id of the created event