Represents a game template in API endpoint responses.

Whether this game template has tutorials.

A model containing information about a group

The Roblox.Platform.Groups.IGroup's name.

A model containing information about a place

A model containing information about a place to be configured

Returns the id of the place's universe, or null - if the place is not part of a universe.

Model for private server details responses from the UniverseSettings controller.

The number of active VIP servers for this universe. A negative value indicates at least this many exist (i.e. -100 means 100+ active private servers).

The number of active VIP server subscriptions. A negative value indicates at least this many exist (i.e. -100 means 100+ active subscriptions).

Whether or not VIP servers are enabled on this universe.

Whether the user can vote on this !:IAsset.

Whether the user has voted on this !:IAsset.

The reason this !:IAsset cannot be voted on.

Whether or not the universe should be enabled for team create

Request model for a TeamCreate membership

A model containing information about a universe permissions

Determines whether or not consumer can cloud the target universe
This is only nullable/optional in the context of https://develop.roblox.com/docs#!/Universes/get_v1_universes_universeId_context_permissions endpoint which is consumed only internally. It should be computed and set for all other usages.

Determines whether or not consumer can manage the target universe

The universe Id these permissions reference

Represents a universe in API endpoint results.

The id of the user or group that created this universe.

The creator type, either "User" or "Group"

Model for UniverseSettings patch requests

Sets the base price of the experience for Fiat purchases.

Determines the change type of the Fiat Product Change request.
Can either Activate the product, Update the price, or Deactivate the product.

Whether game access is limited to friends for user-owned games or group members for group-owned games.

Sets whether access to APIs for mesh and texture is enabled for this universe.

Set is rewarded on-demand ads are allowed for this universe.

List of device types this game can be played on.

 ['Computer' = 1, 'Phone' = 2, 'Tablet' = 3, 'Console' = 4, 'VR' = 5]

Whether custom animations are allowed in the universe.

Which avatar types are allowed in the universe.

What avatar body types are allowed by the universe.

What type of collisions are used by the universe.

What avatar joint positioning type is allowed by the universe.

Whether custom scales allowed in the universe.

Model for UniverseSettings controller responses

If the universe allows the use of private servers.

The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]

Game genre. ['All' = 0, 'Tutorial' = 1, 'Scary' = 2, 'TownAndCity' = 3, 'War' = 4, 'Funny' = 5, 'Fantasy' = 6, 'Adventure' = 7, 'SciFi' = 8, 'Pirate' = 9, 'FPS' = 10, 'RPG' = 11, 'Sports' = 12, 'Ninja' = 13, 'WildWest' = 14]

Whether the game is offered for sale in fiat.

Whether access to APIs for mesh and texture is enabled for this universe.

Whether rewarded on-demand ads are allowed for this universe.

Whether studio access to APIs is allowed or not.

The price to purchase a private server in robux.

Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]

Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

What avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 2]

What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]

What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]

Whether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]

Whether or not the universe is enabled for team create

Whether or not comments should be enabled.

Whether or not the plugin allows comments to be posted.

Develop Api v1

The ids of the Roblox.Platform.Assets.IAsset.

assetIds

Gets the voting information of the given assets

Templates subject to change without notice.
Sort order of templates specified by Roblox.

Gets a page of templates that can be used to start off making games.

groupId

isArchived

limit

The paging cursor for the previous or next page.

cursor

sortOrder

Gets a list of universes for the given group.

Currently the only supported functionality for updating the configuration is around Name, and Description.

The place id for the place to be updated.

placeId

configuration

0: Authorization has been denied for this request.

Authenticated user is not authorized to manage this place.
0: Token Validation Failed

Updates the place configuration for the place with the id placeId

1: The universe is invalid.
5: The place is invalid.

2: Not authorized to perform this action.
4: TeamCreate on universe is disabled.

6: Multiple active sessions in a Team Create place.

List of users in the active Team Create session

pluginIds

1: Too many ids.
2: The format of the ids are invalid.

pluginId

The Roblox.Develop.Api.UpdatePluginRequest.

request

5: Description too long.
6: Text moderated.
7: Invalid name.
8: The request body is missing.

0: Token Validation Failed
4: Insufficient permissions.

If a universe can not be found for a given ID (such as -1) it will be skipped.

8: No universe IDs sent to get.
9: Too many universe IDs sent to get, the limit is: 

Gets a System.Collections.Generic.List`1.

Returns an array of granted and declined permissions related to the universes with the ids in ids for the authenticated user.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TooManyUniverseIdsSent

Gets TeamCreate settings for multiple universes specified by Ids

universeId

Gets a Roblox.Api.Develop.Models.UniverseModel.

1: The universe does not exist.
2: This universe does not have a root place.

0: Token Validation Failed
3: You are not authorized to configure this universe.
6: The root place for this universe is under review and can not be activated.
7: Creator already has the maximum number of places active.

2: You are not authorized to configure this universe.

The Roblox.Api.Develop.Models.UniverseSettingsRequest model.

model

1: The universe does not exist.
3: Invalid UniverseAvatarType.
4: Invalid UniverseScaleType.
5: Invalid UniverseAnimationType.
6: Invalid UniverseCollisionType.
7: New universe name or description has been rejected.
8: New universe name is too long.
10: Invalid UniverseBodyType.
11: Invalid UniverseJointPositioningType.
12: The universe has no root place.
15: Price is required when isForSale is true.
16: This game cannot be offered for sale because it is not public.
17: This game cannot be offered for sale because it has private servers enabled.
18: The game price is outside of the allowed range.
19: Invalid genre.
20: The request body is missing.
21: Invalid device type.
22: Invalid asset type.
23: Invalid value, the min must be less than or equal to the max
24: Invalid scale value

0: Token Validation Failed
2: You are not authorized to configure this universe.
14: You are not authorized to sell games.

9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted.

Update universe settings for an owned universe.

Get settings for an owned universe's VIP servers.

0: Token Validation Failed
3: You are not authorized to configure this universe.

Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user

isUniverseCreation

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized

Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse.

Enables, or disables team create for a universe.

The request body containing the team create settings.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized
0: Token Validation Failed

Edit team create settings for a universe.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse OR Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUser

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TeamCreateDisabled
0: Token Validation Failed

Removes a user from a TeamCreate permissions list.

Gets a list of Groups that a user can manage.

Gets a list of groups a user can manage games or items for.

Gets a list of universes for the authenticated user.

Overview

Experiences

Avatar

Assets

Open Cloud

Create

Discovery

Localization

Analytics

Design

Scale

Affiliates

Monetize

Education

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

{nameStart}name{nameEnd} is no longer supported or maintained by Roblox.

This math operation is no longer supported or maintained by Roblox.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This member is accessible from OpenCloud Luau execution tasks.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible through the command bar and plugins. Attempting to access this member from scripts causes an error.

This member is read only. Attempting to write to this member causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Develop v1