ROroblox
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.

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

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/virtual-events/v3/game-events/{eventId}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe.event:write

Path parameters

eventIdinteger required

Game event ID from the route.

Request body

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'enabled' | 'disabled'

The featuring status of a virtual event.

taglinestring nullable

Response

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'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

Changes

  • 33047aba4a3dRevision changes
    • info

      api operation id GameEvent_Update removed and replaced with GameEvent_UpdateGameEvent

  • 5dcfa33df56aRevision changes
    • breaking

      removed the enum value invalid of the request property //////// (media type: application/json-patch+json)

    • breaking

      removed the enum value invalid of the request property //////// (media type: application/json)

    • breaking

      removed the enum value invalid of the request property //////// (media type: text/json)

    • breaking

      removed the enum value invalid of the request property //////// (media type: application/*+json)

    • warning

      removed the request property //// (media type: application/json-patch+json)

    • warning

      removed the request property //// (media type: application/json)

    • warning

      removed the request property //// (media type: text/json)

    • warning

      removed the request property //// (media type: application/*+json)

    • warning

      removed the optional property from the response with the status

    • info

      removed the invalid enum value from the //// response property for the response status