Abort Multipart Asset Upload
Abort a multipart asset upload. Required API-key permission: asset:write.
Roblox Open Cloud APIs let creators manage experiences, assets, data stores, groups, analytics, localization, and other creator resources. OAuth scopes for following, notification strings, notification reporting, and legacy user settings require a separate Roblox app in the Creation & Productivity Tools category.
Abort a multipart asset upload. Required API-key permission: asset:write.
Accepts a join request. Required API-key permission: group:write.
Activates a universes. Required API-key permission: legacy-universe:manage.
Adds one or more items to a folder. Required API-key permission: marketplace.item:write.
Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#Assets_RestoreAsset) them. Required API-key permission: asset:write.
Permanently archive the specified experience notification string so it can no longer be used for new sends. Required API-key permission: universe.notification-string:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Assigns a specific role to a user within a group. If the user already holds the specified role, no action is taken. Required API-key permission: group:write.
Returns the status (lifecycle state) and deliveryStatus (whether the campaign is currently serving), along with deliveryStatusReasons, for up to 100 campaigns in a single call. This is the recommended way to poll the review and serving state of many campaigns at once. Provide the campaign IDs in campaignIds; any ID that is not found or that the caller can't manage is returned in the failures array with reason NOT_FOUND. A campaign owned by a group is returned to any member with advertising pe. Required API-key permission: ad.campaign:read.
Bulk deletes saves. Max of 5000 saves per request. Required API-key permission: creator-store-save:write.
Update display, sale, or pricing configuration for multiple collectible items in one request. Required API-key permission: marketplace.item:write.
Calculate the minimum detectable effect for a proposed universe experiment and return the operation used to retrieve the result. Required API-key permission: universe:read.
Cancel the collectible item's scheduled on/off sale time. Required API-key permission: marketplace.item:write.
Operation to Check the Eligibility of a Group. Required API-key permission: extended-services:read.
Operation to Check the Eligibility of a User. Required API-key permission: extended-services:read.
Endpoint to return whether the current user can access the features in this API, optionally with a universe ID. Required API-key permission: extended-services:read.
Checks the configure access permissions. Required API-key permission: marketplace.item:read.
Checks the publish access permissions. Required API-key permission: marketplace.item:read.
Checks the upload access permissions. Required API-key permission: marketplace.item:read.
Returns whether the authenticated user (or group on their behalf) may perform the given marketplace action for a specific asset, bundle, or look type. Required API-key permission: marketplace.item:read.
Close a game instance that is being used for team testing. Required API-key permission: legacy-team-collaboration:manage.
Completes an experiment by stopping it and rolling out the requested variant. Required API-key permission: universe:write.
Records a chunk upload complete. Required API-key permission: asset:write.
Records a multipart upload complete and returns a URL to poll the status. Required API-key permission: asset:write.
Creates an asset with provided content and metadata. You can't add `SocialLink` objects when you create an asset. Instead, use [Update Asset](#Assets_UpdateAsset). Provide the `Asset`, binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data. Required API-key permission: asset:write.
Creates a content metadata appeal for an asset. Required API-key permission: marketplace.item-appeal:write.
Starts a multipart upload operation to create assets. Required API-key permission: asset:write.
Mint an avatar item update context (parent operation) for an existing catalog item. Studio threads the returned operationId as the ParentOperationId of the staging asset upload. Required API-key permission: marketplace.item:write.
Charges the selected payment source and creates the badge under the universe's root place. Required API-key permission: legacy-universe.badge:manage-and-spend-robux.
Create a marketplace bundle from the supplied assets and operation context. This can charge the agreed Robux creation fee. Required API-key permission: marketplace.item:publish.
Generate bundle creation context which is necessary for the bundle creation process. Required API-key permission: marketplace.item:publish.
Creates an ad campaign in the billing account. Before creating, call GetCampaignOptions with universeId to confirm the experience is eligible and to choose values it accepts. The creatives you reference must already exist as Open Cloud image assets that you have permission to use; they are validated and saved to your account's reusable creatives when the campaign is created. On success the campaign is returned with deliveryStatus IN_REVIEW, meaning it is queued for ad-policy review and not ye. Required API-key permission: ad.campaign:write.
Add a Creator Store product. Only use this method if your product has never been distributed on the Creator Store; otherwise, use the `PATCH` method to update the product. Required API-key permission: creator-store-product:write.
Creates a dashboard. Required API-key permission: universe.analytics.dashboard:write.
Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. Required API-key permission: universe-datastores.objects:create.
Creates a new developer product with the provided configuration details. Required API-key permission: developer-product:write.
CreateExperienceNotification. Required API-key permission: universe.notification-string:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Returns an ExperimentOperation describing the async create call. Required API-key permission: universe:write.
CreateGameAutoLocalizationTable. Required API-key permission: legacy-universe:manage.
Create a new game event. Returns the full resource on success. Required API-key permission: universe.event:write.
Creates a new game pass with the provided configuration details. Required API-key permission: game-pass:write.
Creates a new folder. Required API-key permission: marketplace.item:write.
Create a new `LuauExecutionSessionTaskBinaryInput`. Required API-key permission: universe.place.luau-execution-session:write.
Creates a new queue item. `ttl` is optional. If omitted, the item expires after 45 days (3888000 seconds). If set, it must be a number ending in `s`, greater than 0 and at most `3888000s`. The response reports expiration as `expireTime`, not `ttl`. If a numerical `priority` is set, the item will be inserted into the queue based on the priority value. The higher the value, the closer to the front of the queue the item will be. If priority values are the same then the item will be inserted afte. Required API-key permission: memory-store.queue:add.
Creates the specified map item if it doesn't exist. Required API-key permission: memory-store.sorted-map:write.
Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. Required API-key permission: universe.ordered-data-store.scope.entry:write.
Creates a task but does not wait for the task to complete. To check whether a task has completed, call the `GetLuauExecutionSessionTask` method and inspect the `state` field of the returned resource. Required API-key permission: universe.place.luau-execution-session:write.
Publish a new place or update an existing place with a new version. Provide a RBXL or RBXLX file in the data-binary. Required API-key permission: universe-places:write.
Creates a task but does not wait for the task to complete. To check whether a task has completed, call the `GetLuauExecutionSessionTask` method and inspect the `state` field of the returned resource. Required API-key permission: universe.place.luau-execution-session:write.
Create a universe metric alert with an evaluation interval, threshold condition, severity, optional dimensions, and optional webhook receivers. Required API-key permission: universe.analytics.alert:write.
Creates a save. Required API-key permission: creator-store-save:write.
Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. Required API-key permission: universe-datastores.objects:create.
Creates a new encrypted universe secret. Get the universe public key, encrypt the content with LibSodium sealed box, then base64-encode it and include the key ID. Roblox currently serves this operation only with an Open Cloud API key. Required API-key permission: universe.secret:write.
Creates a new active thumbnail personalization configuration for a universe. This deactivates the current active configuration, and the new configuration starts its own statistics. Required API-key permission: universe.thumbnail:write.
CreateUniverseLogRegex. Required API-key permission: universe.analytics:write.
Sends a notification to a user. Required API-key permission: user.user-notification:write.
Deactivates a universe. Required API-key permission: legacy-universe:manage.
Declines a join request. Required API-key permission: group:write.
Deletes an alert configuration. This action is irreversible. Required API-key permission: universe.analytics.alert:write.
Delete a localized icon from a badge. Required API-key permission: legacy-badge:manage.
Delete localized name and description of a badge. Required API-key permission: legacy-badge:manage.
Resets the current draft area. If draftHash is provided, this call will fail if the hash doesn't match. Required API-key permission: universe:write.
Deletes a dashboard. Required API-key permission: universe.analytics.dashboard:write.
Schedules the specified data store for permanent deletion. This operation assigns the data store an expiry time 30 days in the future, at which point permanent deletion begins. To cancel, use the `UndeleteDataStore` operation before the data store's expiry time. Permanent deletion consists of deleting all of the entries in the data store and then the data store resource itself. The data store is no longer returned by the `ListDataStores` Open Cloud endpoint or `ListDataStoresAsync` Luau API,. Required API-key permission: universe-datastores.control:delete.
Marks the specified entry for deletion. Entries are not be deleted immediately; instead, the `state` field will be set to `DELETED`. Permanent deletion occurs after 30 days. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. Required API-key permission: universe-datastores.objects:delete.
Delete a localized icon from a developer product. Required API-key permission: legacy-developer-product:manage.
Delete localized name and description of a developer product. Required API-key permission: legacy-developer-product:manage.
Permanently delete an existing game event. Roblox currently rejects OAuth resource authorization on event-ID routes, so use an Open Cloud API key. Required API-key permission: universe.event:write.
Delete a localized icon from a game. Required API-key permission: legacy-universe:manage.
Delete a localized icon from a game pass. Required API-key permission: legacy-game-pass:manage.
Delete localized name and description of a game pass. Required API-key permission: legacy-game-pass:manage.
Deletes the game thumbnail. Required API-key permission: legacy-universe:manage.
Deletes homepage thumbnails from a universe. Required API-key permission: universe.thumbnail:write.
Deletes a folder. Required API-key permission: marketplace.item:write.
Deletes the specified item from the map. Required API-key permission: memory-store.sorted-map:write.
Deletes the specified entry. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. Required API-key permission: universe.ordered-data-store.scope.entry:write.
Deletes a save. Required API-key permission: creator-store-save:write.
Marks the specified entry for deletion. Entries are not be deleted immediately; instead, the `state` field will be set to `DELETED`. Permanent deletion occurs after 30 days. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. Required API-key permission: universe-datastores.objects:delete.
Permanently deletes a secret from a universe. This operation is irreversible. Roblox currently serves it only with an Open Cloud API key. Required API-key permission: universe.secret:write.
DeleteUniverseLogRegex. Required API-key permission: universe.analytics:write.
Delists an item, permanently archiving it so it is no longer visible to any users on the marketplace. Required API-key permission: marketplace.item:write.
The experiment record is retained with state Deleted. Required API-key permission: universe:write.
Discards read items from the front of the queue. Takes a `readId` from a previous `Read` operation. Required API-key permission: memory-store.queue:discard.
Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported. You should request that URL with the `Accept-Encoding: gzip` header and decompress the result if the response is gzipped. If you are using cURL, the `--compressed` flag will automate these steps for you. This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`. While you are able to mak. Required API-key permission: legacy-asset:manage.
Refer to the assetId endpoint for details on usage. This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`. While you are able to make requests to this endpoint with Cookie authentication via `assetdelivery.roblox.com/v1/openCloud/assetId/{assetId}/version/{versionNumber}`, we highly discourage use this way. Expect unannounced removal of this second route in the future. Required API-key permission: legacy-asset:manage.
Asynchronously flush all data structures in the universe. Unlike some other endpoints, the flush response `path` already includes the `cloud/v2` prefix. Poll the operation at `https://apis.roblox.com/{path}` without adding another prefix. Required API-key permission: memory-store:flush.
Creates the following between a user with userId and universe with universeId. Required API-key permission: legacy-universe.following:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Forecast the impact of restarting game servers for a universe. Required API-key permission: universe:read.
Generates an English speech audio asset from the specified text. This endpoint requires the `asset:read` and `asset:write` scopes in addition to the `universe:write` scope. The response returns an `Operation` object that must be prefixed with `/assets/v1`. For example, the URL to discover the result of the operation could be `https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d`. Required API-key permissions: asset:read, asset:write, universe:write.
Generates and returns the URL for the user's avatar thumbnail. This is a long-running operation: the response is an `Operation` object. Poll the operation using its returned `path` until `done` is `true`. A completed operation contains either `response` or `error`: - If `response` is set, `response.imageUri` contains the thumbnail URL. - If `error` is set, the thumbnail couldn't be generated and `response` is not set. `error.code` and `error.message` describe the reason. Always check for `err.
Operation to Get an Account for a Group. Required API-key permission: extended-services:read.
Operation to Get an Account for a User. Required API-key permission: extended-services:read.
Retrieve specific asset metadata. Required API-key permission: asset:read.
Get 3D thumbnail metadata and model URLs for Roblox assets. Required API-key permission: thumbnail:read.
Get details for a single Creator Store asset. Required API-key permission: creator-store-product:read.
Checks the appeal status for an asset. Required API-key permission: marketplace.item-appeal:read.
Get the result of an asset creation or update using the returned Operation ID. Required API-key permission: asset:write.
Retrieve a specific asset version by the asset ID and the version number. Required API-key permission: asset:read.
Metadata for AutoLocalization Configuration. Required API-key permission: legacy-universe:manage.
Operation to Get Billing Statement for group owned account. Required API-key permission: extended-services:read.
Operation to Get Billing Statement for user owned account. Required API-key permission: extended-services:read.
Returns a single billing account accessible to the authenticated user (including group accounts where the caller has group advertising permission). Includes masked card details, verification state, and a payment-status reason when the account is not ready. Returns 404 if the account does not exist or is not accessible to the caller. Required API-key permission: ad.billing:read.
Operation to Get Billing Activities. Required API-key permission: extended-services:read.
Operation to Get Billing Activities. Required API-key permission: extended-services:read.
Gets the asset status and other configuration details for the given assetIds list. Required API-key permission: marketplace.item:read.
Gets TeamCreate settings for multiple universes specified by Ids. Required API-key permission: legacy-team-collaboration:manage.
Get the connected user's granted and denied permissions for multiple universes; inaccessible universe IDs are omitted. Required API-key permission: legacy-universe:manage.
Get status on the CreateBundle request that was previously queued up. Required API-key permission: marketplace.item:read.
Get metadata for bundle creation and publishing. Required API-key permission: marketplace.item:read.
Returns a single campaign, including its status (the lifecycle state you control: ACTIVE, PAUSED, or CANCELLED) and its deliveryStatus (whether it is currently serving: SERVING, IN_REVIEW, NOT_SERVING, or REJECTED). deliveryStatusReasons lists any reasons that affect delivery — for example why a campaign is not serving or was rejected, or that a serving campaign is still in its initial learning period. Returns 404 if the campaign does not exist or the caller can't manage it. A campaign owned. Required API-key permission: ad.campaign:read.
Returns the values accepted when creating a campaign: supported objectives, payment types, ad formats, and targeting dimensions. Call this before CreateCampaign. When universeId is supplied, the response also includes an eligibility block indicating whether that experience can currently be advertised, along with the reasons when it cannot. universeId is optional; without it, account-level options are returned without eligibility or billing-account resolution. A caller without permission to ad. Required API-key permission: ad.campaign:read.
Get commission rates for collectibles. Required API-key permission: marketplace.item:read.
Get the price floor for a given item. Required API-key permission: marketplace.item:read.
Gets the publishing fee required to publish a collectible item. Required API-key permission: marketplace.item:read.
Gets metadata for Collectibles publishing. Required API-key permission: marketplace.item:read.
Returns structured restock eligibility information for a given collectible item. This is the single source of truth the frontend should use to determine whether restocking is available, instead of re-deriving from individual flags. Required API-key permission: marketplace.item:read.
Get the restocking fee for a given collectible item and additional quantity. Required API-key permission: marketplace.item:read.
Get Revenue Split for collectibles. Required API-key permission: marketplace.item:read.
Returns the current draft changes for the configuration repository. Required API-key permission: universe:read.
Returns the full config including metadata (version, descriptions, last modified/accessed times). Required API-key permission: universe:read.
Returns the latest published config values without metadata and decorators. This response can be used as a direct copy-and-paste to the draft update endpoints. Required API-key permission: universe:read.
Operation to Get ConsumerConfiguration for a universe. Required API-key permission: extended-services:read.
Get a Creator Store product. Required API-key permission: creator-store-product:read.
Get the custom-dashboard capabilities available to a universe, including supported metrics and widgets. Required API-key permission: universe.analytics.dashboard:read.
Gets the latest published dashboard snapshot. Required API-key permission: universe.analytics.dashboard:read.
Gets the specified entry. To get the entry at a specific revision, add `@<revisionId>` to the end of the path. For example, to get `my-entry` at the revision ID `08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`. If your entry ID contains one or more `@` characters, and you want to get the latest version rather than at any specific revision, append the special revision ID. Required API-key permission: universe-datastores.objects:read.
Get developer product with configuration details. Required API-key permission: developer-product:read.
Get the current result of a previously started universe analytics dimension-values query. Required API-key permission: universe.analytics:read.
GetExperienceNotification. Required API-key permission: universe.notification-string:read. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Get aggregated analytics for an experience notification, filtered by universe, user, and time range. Required API-key permission: universe.analytics:read.
Returns the `experiment`. Returns 404 if the experiment doesn't exist for the universe. Required API-key permission: universe:read.
Polled by clients between mutations (Create / Update / Start / Schedule / Complete / Discard) to determine when the operation reaches `done = true`. Required API-key permission: universe:read.
Gets diagnostic stats for an experiment. Required API-key permission: universe:read.
Get the automatic translation status of supported languages for a game. Required API-key permission: legacy-universe:manage.
Get UniverseDisplayInfo automatic translation settings. Required API-key permission: legacy-universe:manage.
Get a single game event by ID. Roblox currently rejects OAuth resource authorization on event-ID routes, so use an Open Cloud API key. Required API-key permission: universe.event:read.
Get game pass with configuration details. Required API-key permission: game-pass:read.
Gets available filter options for game servers. Required API-key permission: universe:read.
Gets the history for name or description in a provided language. Required API-key permission: legacy-universe:manage.
Get public metadata for a Roblox group by numeric group ID. Public group metadata needs no additional operation scope; private administration, forums, memberships, and roles are not included.
Gets the Group's audit log. Required API-key permission: legacy-group:manage.
Gets group policy info used for compliance. Required API-key permission: legacy-group:manage.
Get the group role. Required API-key permission: group:read.
Gets the Group's settings. Required API-key permission: legacy-group:manage.
Gets the processing status of homepage thumbnail upload operations. Required API-key permission: universe.thumbnail:read.
Gets a page of homepage thumbnails for a universe. Required API-key permission: universe.thumbnail:read.
Get a specific folder by its ID. Required API-key permission: marketplace.item:read.
Gets information about a task. Required API-key permissions: universe.place.luau-execution-session:read, universe.place.luau-execution-session:write.
Gets a category hierarchy (by category domain) used to render category chips, e.g. on the creator dashboard. Required API-key permission: marketplace.item:read.
Get an item by its id. Required API-key permission: marketplace.item:read.
Get the price floor. Required API-key permission: marketplace.item:read.
Get the upload fee for an item type. Required API-key permission: marketplace.item-upload-fee:read.
Retrieves the status of the operation to [flush the memory stores of a universe](https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_FlushMemoryStore). Required API-key permission: memory-store:get.
Gets and returns the value of the given key in the map. Required API-key permission: memory-store.sorted-map:read.
Get the current result of a previously started universe analytics metrics query. Required API-key permission: universe.analytics:read.
Gets the specified entry. Required API-key permission: universe.ordered-data-store.scope.entry:read.
Get 3d object for an outfit. Required API-key permission: thumbnail:read.
Get the latest published snapshot of the dashboard pinned for a universe. Required API-key permission: universe.analytics.dashboard:read.
Gets the specified place.
Endpoint used to fetch all previous contributors of a place. Required API-key permission: universe.place:read.
Gets an instance and its property data. The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned `Operation` will be completed with an error result that has an error code of `422`. Required API-key permission: universe.place.instance:read.
Retrieves the status of the operation to [update an instance](https://create.roblox.com/docs/cloud/reference/features/universes#Cloud_UpdateInstance).
Get the user restriction. Required API-key permission: universe.user-restriction:read.
Endpoint used to get place versions, using various filters. Required API-key permission: universe.place:read.
Retrieves the public key for a universe. You need this key to encrypt secret content before sending it to Roblox. Only the owner of the universe can retrieve the public key. For group-owned universes, only the group owner or authorized members can retrieve the public key. The secret id field is static and always returns 'public-key'. The returned public key in the secret field is universe-specific and derived from a master key using the universe ID. Roblox currently serves this operation only with an Open Cloud API key. Required API-key permission: universe.secret:read.
Gets saves from a collection. Required API-key permission: creator-store-save:read.
Gets the specified entry. To get the entry at a specific revision, add `@<revisionId>` to the end of the path. For example, to get `my-entry` at the revision ID `08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`. If your entry ID contains one or more `@` characters, and you want to get the latest version rather than at any specific revision, append the special revision ID. Required API-key permission: universe-datastores.objects:read.
Get the subscription. The `universe.subscription-product.subscription:read` scope only allows reading subscriptions of the user making the request. Because of this, the subscription ID must match the user ID of the user making the request. Note that this scope might be more relevant for OAuth 2.0 apps. To read all subscriptions made by users for a particular universe, use the `universe:write` scope instead. Required API-key permissions: universe.subscription-product.subscription:read, universe:write.
Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse. Required API-key permission: legacy-team-collaboration:manage.
Gets the translation history for each entry passed in. Required API-key permission: legacy-universe:manage.
Get table information by the id of the table. Required API-key permission: legacy-universe:manage.
Get table information by the assetId of the table. Required API-key permission: legacy-universe:manage.
Gets the number of entries in the specified table. Required API-key permission: legacy-universe:manage.
Get limits for translation table entries operations. Required API-key permission: legacy-universe:manage.
Gets the specified universe.
Gets the status of a following relationship between a user and a universe. Required API-key permission: legacy-universe.following:read. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Get daily benchmark percentiles for a universe metric over a specified date range. Required API-key permission: universe.analytics:read.
Get logs based on message hash ids, keywords, placeVersions, start/end time. Required API-key permission: universe.analytics:read.
Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user. Required API-key permission: legacy-universe:manage.
Get the user restriction. Required API-key permission: universe.user-restriction:read.
Get a Roblox user's public profile by numeric user ID. Public profile fields need no additional operation scope; verification and social-account fields are not returned by this tool.
Get Avatar 3d object for a user. Required API-key permission: thumbnail:read.
Gets the status and result of a [Generate User Thumbnail](https://create.roblox.com/docs/cloud/reference/features/users#Cloud_GenerateUserThumbnail) long-running operation. Call this with the operation `path` returned by Generate User Thumbnail, polling until `done` is `true`. Once complete, the operation contains either `response` or `error`: - If `response` is set, `response.imageUri` contains the generated thumbnail URL. - If `error` is set, the thumbnail couldn't be generated and `respons.
Grant a subject permission to multiple assets. Authorization is required to grant permissions to the subject and asset IDs in the request. Required API-key permission: asset-permissions:write.
Mark a universe log-attribute regex rule as ignored. Required API-key permission: universe.analytics:write.
Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Incrementing specific revisions of the entry is **unsupported**. If you specify a revision ID in the path, the increment request will create a new entry with the `@<revisionId>` suffix as part of the key. Known issue: the value may be incremented past the valid range of values. When this happens, the returned val. Required API-key permissions: universe-datastores.objects:create, universe-datastores.objects:update.
Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API. Required API-key permission: universe.ordered-data-store.scope.entry:write.
Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Incrementing specific revisions of the entry is **unsupported**. If you specify a revision ID in the path, the increment request will create a new entry with the `@<revisionId>` suffix as part of the key. Known issue: the value may be incremented past the valid range of values. When this happens, the returned val. Required API-key permissions: universe-datastores.objects:create, universe-datastores.objects:update.
Returns the universe IDs of every experience the billing account is eligible to advertise. The complete list is returned in a single response; this endpoint is not paginated. Use these IDs to set targetUniverseId when creating a campaign, and resolve experience names with the Open Cloud Universe API. With groupId, the list is limited to experiences owned by that group. Required API-key permission: ad.campaign:read.
Gets agents of type requestModel.AgentType who are allowed to perform requestModel.ActionType for assetType. Required API-key permission: marketplace.item:read.
Returns a list of asset quotas. Required API-key permission: asset:read.
List all versions of a specific asset, with optional pagination. Required API-key permission: asset:read.
Get all icons for a badge. Required API-key permission: legacy-badge:manage.
List localized names and descriptions for a badge. Required API-key permission: legacy-badge:manage.
Lists the billing accounts owned by the authenticated user, or by the group in groupId. Each account includes its type, status, time zone, create/update timestamps, creator, and funding state (paymentStatus, supportedPaymentTypes, balances, paymentMethods). Group accounts support only ADS_CREDIT. Funding state belongs to the account, not to any experience, so this response alone answers whether each account can pay for campaigns; GET /campaign-options with universeId only narrows which of the. Required API-key permission: ad.billing:read.
Lists the campaigns in the caller's billing account. Results are paginated with a cursor (pageToken); each page returns up to maxPageSize campaigns (default 50, max 100). groupId lists a group's billing account instead, and targetUniverseIds lists the campaigns of those experiences across billing accounts; campaigns that ended more than 730 days ago aren't included, and a page can hold fewer than maxPageSize campaigns while more remain. When nextPageToken is present, use it to continue even i. Required API-key permission: ad.campaign:read.
Requires an authenticated caller with read access to the universe. `sessionId` must be a non-zero UUID. Results default to `message_timestamp desc` when `orderBy` is omitted. Required API-key permission: universe:read.
Return one page of collectible inventory items for a Roblox user. The tool always applies Roblox's live-verified public-access filter onlyCollectibles=true; broader or private inventory visibility can still require a key owned by the target user with Inventory: Read permission. Pass the returned next_cursor with the same user_id and page_size to continue.
Returns the list of previous revisions to the repository. Supports optional start/end time and pagination. Required API-key permission: universe:read.
Lists the reusable creatives saved to the caller's billing account. Each creative includes its assetId, name, moderation status, dimensions, and source. Use isArchived to filter by archive state. Results are paginated with a cursor (pageToken). A filtered page can be short or empty while more results remain; continue until nextPageToken is absent. Required API-key permission: ad.campaign:read.
Gets the marketplace items for a creator by item type (e.g. bundle, asset). Required API-key permission: marketplace.item:read.
Lists dashboard metadata for a universe. Required API-key permission: universe.analytics.dashboard:read.
Returns a list of entries from a data store. Only the `path` and `id` fields are populated; use `GetDataStoreEntry` to retrieve other fields. Specify the wildcard scope (`-`) to list entries from all scopes. Required API-key permission: universe-datastores.objects:list.
List revisions of the data store entry. This method returns partial data store entries. In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`, `revisionId`, `etag`, and `state` fields are populated. Both the `path` and `id` fields will have an `@<version>` suffix. In order to get the full entry at a revision, you can use the provided `path` field with the `GetDataStoreEntry` method, i.e. `GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`. Required API-key permission: universe-datastores.versions:list.
Returns a list of data stores. Data stores scheduled for permanent deletion are omitted from the results by default (or when `showDeleted` is set to `false`). When this is the case, the operation will check up to 512 data stores. If all checked data stores are deleted, it will return an empty list with a page token to continue iteration. Required API-key permission: universe-datastores.control:list.
List developer products by universe with configuration details. Required API-key permission: developer-product:read.
Get all icons for a developer product. Required API-key permission: legacy-developer-product:manage.
Get all names and descriptions of a developer product. Required API-key permission: legacy-developer-product:manage.
List one page of experience notification-string configurations for a universe. Required API-key permission: universe.notification-string:read. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Pagination is offset-based (`maxPageSize` + `skip`). The response carries the page slice plus the unpaginated total matching the filters. Request includes optional pagination, search, and filters. Required API-key permission: universe:read.
Gets the contents of a specific folder. Required API-key permission: marketplace.item:read.
Gets all universes followed by a user. Required API-key permission: legacy-universe.following:read. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
List game events under a universe. Use `?fields=` to trim the response payload. Response is always 200 (empty list for unknown universe). Required API-key permission: universe.event:read.
Get all icons for a game. Required API-key permission: legacy-universe:manage.
List game passes by universe with configuration details. Required API-key permission: game-pass:read.
Get all icons for a game pass. Required API-key permission: legacy-game-pass:manage.
Get all names and descriptions of a game pass. Required API-key permission: legacy-game-pass:manage.
Lists game server logs for a specific server job id. Required API-key permission: universe:read.
Lists game servers for a specific place version. Required API-key permission: universe:read.
Lists forum categories in the group. Supports filtering. Required API-key permission: group-forum:read.
Lists forum comments on a group's forum post. Supports filtering. Required API-key permission: group-forum:read.
Lists forum posts in the group's forum category. Supports filtering. Required API-key permission: group-forum:read.
List join requests under a group. Supports filtering. Required API-key permission: group:read.
List group members in a group. Supports filtering.
List roles in a group. Roles can be public or private. The response includes private roles and their fields only when the acting user is permitted to view them. The endpoint does not provide a public-roles-only view. The permissions field for roles is viewable based on the requester's access and scopes. Permissions for the guest role are always visible - a scope is not needed. If the requester is a member of the group and has the `group:read` scope, permissions in their role are visible. If t. Required API-key permission: group:read.
Gets all folders belonging to the User or a Group. Required API-key permission: marketplace.item:read.
Lists log chunks generated by a `LuauExecutionSessionTask`. Required API-key permissions: universe.place.luau-execution-session:read, universe.place.luau-execution-session:write.
Gets a list of Groups that a user can manage. Required API-key permission: legacy-group:manage.
Returns a list of allowed groups for a given Roblox.ItemConfiguration.Api.Enums.MarketplaceAction. Required API-key permission: marketplace.item:read.
Gets item types which the requested action can be performed on. Required API-key permission: marketplace.item:read.
Gets and returns items in the map with a given order and filter. Required API-key permission: memory-store.sorted-map:read.
Returns a list of entries from an ordered data store. Required API-key permission: universe.ordered-data-store.scope.entry:read.
Operation to List Payment Profiles of a User. Required API-key permission: extended-services:read.
Gets groups that the authenticated user has requested to join. Required API-key permission: legacy-group:manage.
Lists an instance's children. The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned `Operation` will be completed with an error result that has an error code of `422`. Required API-key permission: universe.place.instance:read.
List user restrictions for users that have ever been banned in either a universe or a specific place. Required API-key permission: universe.user-restriction:read.
Get the representative countries for regional pricing. Required API-key permission: marketplace.item:read.
Returns the alert configurations for a resource. Optionally filter by alert IDs, firing status, severity, or metric name. Required API-key permission: universe.analytics.alert:read.
Returns alert incidents for a resource whose active window overlaps the specified time range. An incident is included if it was open at any point between `startTime` and `endTime`. Required API-key permission: universe.analytics.alert:read.
List restart statuses for a universe. Required API-key permission: universe:read.
Returns a list of entries from a data store. Only the `path` and `id` fields are populated; use `GetDataStoreEntry` to retrieve other fields. Specify the wildcard scope (`-`) to list entries from all scopes. Required API-key permission: universe-datastores.objects:list.
List revisions of the data store entry. This method returns partial data store entries. In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`, `revisionId`, `etag`, and `state` fields are populated. Both the `path` and `id` fields will have an `@<version>` suffix. In order to get the full entry at a revision, you can use the provided `path` field with the `GetDataStoreEntry` method, i.e. `GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`. Required API-key permission: universe-datastores.versions:list.
Lists all secrets defined for a universe. Secret content is not returned for security reasons - only metadata such as ID, domain, creation and update timestamps are included. Only the owner of the universe can list secrets. Roblox currently serves this operation only with an Open Cloud API key. Required API-key permission: universe.secret:read.
List of users in the active Team Create session. Required API-key permission: legacy-team-collaboration:manage.
Gets a page of thumbnail personalization configurations for a universe. Required API-key permission: universe.thumbnail:read.
Gets the marketplace items for a token (i.e. an IEC avatar creation token). Required API-key permission: marketplace.item:read.
Gets a batch of entries for a table. Required API-key permission: legacy-universe:manage.
List universe log-attribute regex rules, optionally filtered by status. Required API-key permission: universe.analytics:read.
Gets the user created asset information filtered by the given asset type. Required API-key permission: marketplace.item:read.
List changes to UserRestriction resources within a given universe. This includes both universe-level and place-level restrictions. For universe-level restriction logs, the `place` field will be empty. Required API-key permission: universe.user-restriction:read.
List user restrictions for users that have ever been banned in either a universe or a specific place. Required API-key permission: universe.user-restriction:read.
Gets all the followings between a user with userId and universes. Required API-key permission: legacy-universe.following:read. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Full overwrite of current draft. The payload is the expected final state after publish (not a merge with the draft or published config from the client’s perspective). The service aligns that intent with CMS validation by emitting explicit deletions for published keys and conditional branches omitted from the body. If a key is not included, it is interpreted as removed. When `conditionalRules` is included, `conditionalRules.rules` is authoritative for rule definitions: any conditional rule tha. Required API-key permission: universe:write.
Previews the publishing fee for an item type before the item exists, so the fee can be shown at upload time. Takes the item's type directly instead of a target id. Required API-key permission: marketplace.item:read.
Get the preview for regional prices. Required API-key permission: marketplace.item:read.
Gets the rental pricing preview for a collectible item. Can include regional pricing if enabled. Required API-key permission: marketplace.item:read.
Publish an asset or bundle as a collectible. This can charge the agreed Robux publishing fee to the specified publisher. Required API-key permission: marketplace.item:publish.
Applies the current draft to the published config. Requires a draft hash and optional message and deployment strategy. Required API-key permission: universe:write.
Publishes a caller-provided dashboard document. Required API-key permission: universe.analytics.dashboard:write.
Publishes a message to the universe's live servers. Servers can consume messages via [MessagingService](https://create.roblox.com/docs/reference/engine/classes/MessagingService). Required API-key permission: universe-messaging-service:publish.
See the <a href='https://create.roblox.com/docs/cloud/guides/analytics'>Analytics guide</a> for more information. Required API-key permission: universe.analytics:read.
Query universe analytics time-series metrics over a time range with optional filters and breakdown dimensions. Required API-key permission: universe.analytics:read.
Read queue items and temporarily hide them from subsequent reads for the requested invisibility window, which defaults to 30 seconds. Required API-key permission: memory-store.queue:dequeue.
Removes one or more items from a folder. Required API-key permission: marketplace.item:write.
Removes a user from a TeamCreate permissions list. Required API-key permission: legacy-team-collaboration:manage.
Orders the specified image Ids for the game thumbnails. Required API-key permission: legacy-universe:manage.
Change the evaluation order of a universe log-attribute regex rule. Required API-key permission: universe.analytics:write.
Report a specific experience notification to Roblox. Required API-key permission: notification-report:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Launch a game server restart for a universe. Required API-key permission: universe:write.
Restarts active servers for a specific universe. Defaults to only restarting servers running older versions, but can be configured to restart all servers regardless of version. Used for releasing experience updates. Required API-key permission: universe:write.
Increase a limited collectible's total quantity and charge the agreed Robux restocking fee. Required API-key permission: marketplace.item:publish.
Restores an archived asset. Required API-key permission: asset:write.
Attempts to restore configs to the provided revision. This will clear the staging and stage a revert commit. You must call publish for the revert to take effect. Required API-key permission: universe:write.
Rollback an asset to a specific previous version. Provide the asset version path in the request body. Required API-key permission: asset:write.
Body must include `scheduledStartTime` as an ISO-8601 UTC timestamp. Required API-key permission: universe:write.
Search Creator Store for assets. Required API-key permission: creator-store-product:read.
Search Creator Store for assets. Required API-key permission: creator-store-product:read.
Sets the source language of a game. Required API-key permission: legacy-universe:manage.
Sets group status. Required API-key permission: legacy-group:manage.
Takes a new snapshot of the data stores in an experience. After a snapshot, the next write to every key in the experience will create a versioned backup of the previous data, regardless of the time of the last write. In effect, all data current at the time of the snapshot is guaranteed to be available as a versioned backup for at least 30 days. Snapshots can be taken once per UTC day, per experience. If the latest snapshot was taken within the same UTC day, this operation is a no-op and the t. Required API-key permission: universe-datastores.control:snapshot.
For a future-dated start, use the sibling `:schedule` endpoint. Required API-key permission: universe:write.
Translates the provided text from one language to another. Required API-key permission: universe:write.
Unassigns a specific role from a user within a group. If the user does not hold the specified role, no action is taken. Required API-key permission: group:write.
Restore the data store. Required API-key permission: universe-datastores.control:delete.
Stop the authorizing user from following experience notifications for a universe. Required API-key permission: universe.following:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Deletes the following between a user with userId and universe with universeId. Required API-key permission: legacy-universe.following:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Operation to Update an Account for a Group. Required API-key permission: extended-services:write.
Operation to Update an Account for a User. Required API-key permission: extended-services:write.
Update a universe metric alert's condition, severity, state, dimensions, filters, or webhook configuration. Required API-key permission: universe.analytics.alert:write.
Updates an asset's content, metadata, or both. Metadata includes the description, display name, icon, social links, and previews. Updating content creates a new asset version and is supported for **Models** and **Places**. For Places, set `published` to `true` to publish the new version. Icons and previews must be **Image** assets, and icons must have square dimensions. Provide the `Asset`, binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limi. Required API-key permission: asset:write.
Starts a multipart upload operation to update assets. Required API-key permission: asset:write.
Managers may change enabled state, name, and description when authorized for the badge. Required API-key permissions: legacy-universe.badge:manage-and-spend-robux, legacy-universe.badge:write.
Update localized description of a badge. Required API-key permission: legacy-badge:manage.
Update a badge's icon. Required API-key permission: legacy-badge:manage.
Update localized name of a badge. Required API-key permission: legacy-badge:manage.
Update localized name and description of a badge. Required API-key permission: legacy-badge:manage.
Updates the mutable fields of a campaign. You can change: name, budget.amountMicros, schedule.startTime and schedule.durationInDays (schedule changes are only allowed before the campaign starts), status, and creativeAssetIds. New creative asset IDs are appended; IDs already attached to the campaign are ignored, and an empty list is a successful no-op. Set status to ACTIVE to run or resume the campaign, PAUSED to pause it, or CANCELLED to cancel it permanently. Setting CANCELLED on a campaign. Required API-key permission: ad.campaign:write.
Update the display information of an item. Required API-key permission: marketplace.item:write.
Update product information about a published Collectible Item. Required API-key permission: marketplace.item:write.
Updates the draft treating the payload as a partial changeset. If draftHash is provided, this call will fail if the hash doesn't match. A key not included will not be changed. To indicate deletion, set key to null. To discard a change, set key to its currently published value. When `conditionalRules` is omitted or empty (`{}`), the CMS update omits the conditional-rules field so existing published rules remain at publish time; send a non-empty `conditionalRules` object to merge rule changes. Required API-key permission: universe:write.
Operation to Update ConsumerConfiguration for a universe. Required API-key permission: extended-services:write.
Update a Creator Store product. Required API-key permission: creator-store-product:write.
Updates dashboard metadata. Required API-key permission: universe.analytics.dashboard:write.
Updates the value, attributes, and users of an entry. Updating specific revisions of the entry is **unsupported**. If you specify a revision ID in the path and `allow_missing` is `true`, the update request will instead create a new entry with the `@<revisionId>` suffix as part of the key. Partial update is **unsupported**. If attributes or users are not provided when updating the value, they will be cleared. Value must always be provided when updating an entry. Required API-key permission: universe-datastores.objects:update.
Updates a developer product with the provided configuration details. Note that only fields provided in the request will be updated. Required API-key permission: developer-product:write.
Update localized description of a developer product. Required API-key permission: legacy-developer-product:manage.
Update a developer product's icon. Required API-key permission: legacy-developer-product:manage.
Update localized name of a developer product. Required API-key permission: legacy-developer-product:manage.
Update localized name and description of a developer product. Required API-key permission: legacy-developer-product:manage.
Update an experience notification string's name or content. Required API-key permission: universe.notification-string:write. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
The payload is a full replacement of the mutable experiment fields. Returns an ExperimentOperation describing the async update. Required API-key permission: universe:write.
Sets a game's auto-localization related settings. Required API-key permission: legacy-universe:manage.
Update the switch which controls if the UniverseDisplayInformation should be automatically translated. Required API-key permission: legacy-universe:manage.
Partially update a game event. Roblox currently rejects OAuth resource authorization on event-ID routes, so use an Open Cloud API key. Required API-key permission: universe.event:write.
Enable or disable automatic translation for a game and language. Required API-key permission: legacy-universe:manage.
Enable or disable image translation for a game and language. Required API-key permission: legacy-universe:manage.
Update a game's icon. Required API-key permission: legacy-universe:manage.
Updates a game's name and/or description in multiple languages. Required API-key permission: legacy-universe:manage.
Updates a game pass with the provided configuration details. Note that only fields provided in the request will be updated. Required API-key permission: game-pass:write.
Update localized description of a game pass. Required API-key permission: legacy-game-pass:manage.
Update a game pass's icon. Required API-key permission: legacy-game-pass:manage.
Update localized name of a game pass. Required API-key permission: legacy-game-pass:manage.
Update localized name and description of a game pass. Required API-key permission: legacy-game-pass:manage.
Add or remove supported languages for a game. Required API-key permission: legacy-universe:manage.
Updates the game thumbnail alt text. Required API-key permission: legacy-universe:manage.
Updates the groups description. Required API-key permission: legacy-group:manage.
**Deprecated.** Use AssignGroupRole and UnassignGroupRole instead. Updates the group membership for a particular group member. This action requires the requester to be able to assign or remove roles below their highest role. The requester cannot change their own roles. Required API-key permission: group:write.
Updates the group's settings. Required API-key permission: legacy-user:manage. OAuth setup: this scope is available only to Roblox OAuth apps in the Creation & Productivity Tools category; use a separate Roblox connection configured with that category.
Updates the group's settings. Required API-key permission: legacy-group:manage.
Updates folder details. Required API-key permission: marketplace.item:write.
Updates the specified map item. A provided sort key replaces the stored sort key. Omitting both `stringSortKey` and `numericSortKey` clears the stored sort key. Sending both is invalid. Required API-key permission: memory-store.sorted-map:write.
Updates the value of an entry. Required API-key permission: universe.ordered-data-store.scope.entry:write.
Updates the specified place. To avoid overwriting changes, this endpoint responds with an HTTP 409 Conflict error if the place is open in an active Team Create session. Required API-key permission: universe.place:write.
Updates an instance's property data. When updating a `Script` instance's source property, the maximum supported property size is 200,000 bytes after UTF-8 encoding. Required API-key permission: universe.place.instance:write.
Update the user restriction. Required API-key permission: universe.user-restriction:write.
Endpoint used to modify the notes of a particular version for a place. Required API-key permission: universe.place:write.
Updates the value, attributes, and users of an entry. Updating specific revisions of the entry is **unsupported**. If you specify a revision ID in the path and `allow_missing` is `true`, the update request will instead create a new entry with the `@<revisionId>` suffix as part of the key. Partial update is **unsupported**. If attributes or users are not provided when updating the value, they will be cleared. Value must always be provided when updating an entry. Required API-key permission: universe-datastores.objects:update.
Updates an encrypted universe secret's content, key ID, or domain. Roblox currently serves this operation only with an Open Cloud API key. Required API-key permission: universe.secret:write.
Enables, or disables team create for a universe. Required API-key permission: legacy-team-collaboration:manage.
Replaces the homepage thumbnails in an active personalization configuration without changing its identifier or existing statistics. Required API-key permission: universe.thumbnail:write.
Updates the tables contents based on what is provided. Required API-key permission: legacy-universe:manage.
Update universe metadata and availability. Changing private-server pricing can cancel subscriptions, and disabling it closes active private servers. Required API-key permission: universe:write.
Update a universe log-attribute regex rule's pattern, output, or operation. Required API-key permission: universe.analytics:write.
Update the user restriction. Required API-key permission: universe.user-restriction:write.
Uploads the game thumbnail. Required API-key permission: legacy-universe:manage.
Upload one image to create a homepage thumbnail for a universe. Call once per image. Required API-key permission: universe.thumbnail:write.
Validates a candidate dashboard document. Required API-key permission: universe.analytics.dashboard:write.
Return OAuth identity or verify an Open Cloud API key.
The Roblox integration connects your Dench AI CRM directly to Roblox, so agents can read and act on your Roblox data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
347 actions are available for agents to invoke on your behalf. Every call runs through Roblox's own authorization, scoped to the account you connect.
Sign in to your Dench workspace and open Integrations.
Find Roblox and click Connect — you'll authorize access through Roblox's own sign-in flow. No API keys or code required.
Ask an agent to use Roblox in chat, or call it from an automation.
Manage or disconnect the connection any time from workspace settings.
The Dench Roblox integration connects your AI CRM to Roblox, so AI agents can work with your Roblox data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
The Roblox integration currently exposes 347 actions, including Abort Multipart Asset Upload, Accept Group Join Request, Activate Universe, Add Items To Folder, Archive Asset, and Archive Experience Notification. Agents invoke them on your behalf from chat or from automations.
No. You connect Roblox from your Dench workspace using Roblox's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Connections are authorized through Roblox's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Roblox connection from your workspace settings at any time.