v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Game Events

Create a new game event. Returns the full resource on success.

post/virtual-events/v3/universes/{universeId}/game-events

Path parameters

universeIdinteger required

Universe that will own the new event (from path).

Request body

titlestring nullable

Event title. Clients must provide a non-empty value.

subtitlestring nullable

Event subtitle. Clients must provide a non-empty value.

descriptionstring nullable

Optional event description.

startTimestring date-time nullable

Event start time. Clients must provide a timestamp such as yyyy-MM-ddTHH:mm:ss.fffzzz or yyyy-MM-ddTHH:mm:ss.fffZ.

endTimestring date-time nullable

Event end time. Clients must provide a timestamp such as yyyy-MM-ddTHH:mm:ss.fffzzz or yyyy-MM-ddTHH:mm:ss.fffZ, and it must be after VirtualEventsApi.Models.V3.Request.CreateGameEventRequest.StartTime.

visibility'private' | 'public' | 'moderated'

The visibility of a virtual event.

groupIdinteger nullable

Group host. When omitted, the authenticated user is the host.

placeIdinteger nullable

Optional venue place ID. When omitted, the event is created in the universe root place.

featuringStatus'invalid' | 'enabled' | 'disabled'

The featuring status of a virtual event.

taglinestring nullable

Optional tagline. Length and content are validated server-side.

Response

The newly-created game event resource.

idstring nullable

The unique id of the game event. Always populated. Serialized as a string to preserve precision for clients (event IDs exceed 2^53).

titlestring nullable

displayTitlestring nullable

Localized title (caller's locale). Populated only when displayTitle is in the mask.

subtitlestring nullable

displaySubtitlestring nullable

Localized subtitle. Populated only when displaySubtitle is in the mask.

descriptionstring nullable

displayDescriptionstring nullable

Localized description. Populated only when displayDescription is in the mask.

startTimestring date-time nullable

endTimestring date-time nullable

universeIdinteger nullable

placeIdinteger nullable

visibility'private' | 'public' | 'moderated'

The visibility of a virtual event.

featuringStatus'invalid' | 'enabled' | 'disabled'

The featuring status of a virtual event.

taglinestring nullable

Tagline for featuring review; visible to curators only when featuring is opted into.

allThumbnailsCreatedboolean nullable

Whether all requested thumbnails were successfully persisted. Returned on Create/Update.

userRsvpStatus'none' | 'going' | 'maybeGoing' | 'notGoing'

The type of RSVP statuses.

createTimestring date-time nullable

updateTimestring date-time nullable