v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Game Events

Partially update a game event. Only fields present in the request body are changed; omitted or null fields are left unchanged. Empty body is a no-op and returns the current game event resource.

patch/virtual-events/v3/game-events/{eventId}

eventIdinteger required

Game event ID from the route.

titlestring nullable

subtitlestring nullable

descriptionstring nullable

startTimestring date-time nullable

endTimestring date-time nullable

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

The visibility of a virtual event.

placeIdinteger nullable

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

The featuring status of a virtual event.

taglinestring nullable

The updated 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