Files
VRChatBackendDocs/Models/CreateInstanceRequest.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

2.1 KiB

CreateInstanceRequest

Properties

Name Type Description Notes
ageGate Boolean [optional] [default to false]
calendarEntryId String [optional] [default to null]
canRequestInvite Boolean Only applies to invite type instances to make them invite+ [optional] [default to false]
closedAt Date The time after which users won't be allowed to join the instance. This doesn't work for public instances. [optional] [default to null]
contentSettings InstanceContentSettings [optional] [default to null]
displayName String [optional] [default to null]
groupAccessType String Group access type when the instance type is "group" [optional] [default to members]
hardClose Boolean Currently unused, but will eventually be a flag to set if the closing of the instance should kick people. [optional] [default to false]
instancePersistenceEnabled Boolean [optional] [default to null]
inviteOnly Boolean [optional] [default to false]
ownerId String A groupId if the instance type is "group", null if instance type is public, or a userId otherwise [optional] [default to null]
playerPersistenceEnabled Boolean [optional] [default to null]
queueEnabled Boolean [optional] [default to false]
region String Instance region [default to us]
roleIds List Group roleIds that are allowed to join if the type is "group" and groupAccessType is "member" [optional] [default to null]
type String [default to null]
worldId String WorldID be "offline" on User profiles if you are not friends with that user. [default to null]

[Back to Model list] [Back to API list] [Back to README]