Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PATCH /v1/universes/{universeId}/configuration — openapi
Update universe settings for an owned universe.
Endpoint
Method: PATCH
Path: /v1/universes/{universeId}/configuration
Servers:
https://develop.roblox.com
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
| universeId | path | true | The universeId. |
[
{
"in": "path",
"name": "universeId",
"description": "The universeId.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
]Request Body
The Roblox.Api.Develop.Models.UniverseSettingsRequest model.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsRequest"
}
}
},
"description": "The Roblox.Api.Develop.Models.UniverseSettingsRequest model.",
"required": true
}Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | 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 41: You cannot change the private server price again so soon after the previous change. Please try again later. |
| 401 | 0: Authorization has been denied for this request. |
| 403 | 0: Token Validation Failed 2: You are not authorized to configure this universe. 14: You are not authorized to sell games. |
| 409 | 9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted. |
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsResponse"
}
}
}
},
"400": {
"description": "1: The universe does not exist.\r\n3: Invalid UniverseAvatarType.\r\n4: Invalid UniverseScaleType.\r\n5: Invalid UniverseAnimationType.\r\n6: Invalid UniverseCollisionType.\r\n7: New universe name or description has been rejected.\r\n8: New universe name is too long.\r\n10: Invalid UniverseBodyType.\r\n11: Invalid UniverseJointPositioningType.\r\n12: The universe has no root place.\r\n15: Price is required when isForSale is true.\r\n16: This game cannot be offered for sale because it is not public.\r\n17: This game cannot be offered for sale because it has private servers enabled.\r\n18: The game price is outside of the allowed range.\r\n19: Invalid genre.\r\n20: The request body is missing.\r\n21: Invalid device type.\r\n22: Invalid asset type.\r\n23: Invalid value, the min must be less than or equal to the max\r\n24: Invalid scale value\r\n41: You cannot change the private server price again so soon after the previous change. Please try again later."
},
"401": {
"description": "0: Authorization has been denied for this request."
},
"403": {
"description": "0: Token Validation Failed\r\n2: You are not authorized to configure this universe.\r\n14: You are not authorized to sell games."
},
"409": {
"description": "9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted."
}
}Authentication
{
"security": [
{
"roblox-legacy-cookie": []
}
],
"securitySchemes": {
"roblox-api-key": {
"type": "apiKey",
"description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
"name": "x-api-key",
"in": "header"
},
"roblox-legacy-cookie": {
"type": "apiKey",
"description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
"in": "cookie",
"name": ".ROBLOSECURITY"
},
"roblox-oauth2": {
"type": "oauth2",
"description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
"tokenUrl": "https://apis.roblox.com/oauth/v1/token",
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
"scopes": {}
}
}
}
}
}Related Schemas
Complete Operation Definition
{
"tags": [
"Universes"
],
"summary": "Update universe settings for an owned universe.",
"parameters": [
{
"in": "path",
"name": "universeId",
"description": "The universeId.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsRequest"
}
}
},
"description": "The Roblox.Api.Develop.Models.UniverseSettingsRequest model.",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Api.Develop.Models.UniverseSettingsResponse"
}
}
}
},
"400": {
"description": "1: The universe does not exist.\r\n3: Invalid UniverseAvatarType.\r\n4: Invalid UniverseScaleType.\r\n5: Invalid UniverseAnimationType.\r\n6: Invalid UniverseCollisionType.\r\n7: New universe name or description has been rejected.\r\n8: New universe name is too long.\r\n10: Invalid UniverseBodyType.\r\n11: Invalid UniverseJointPositioningType.\r\n12: The universe has no root place.\r\n15: Price is required when isForSale is true.\r\n16: This game cannot be offered for sale because it is not public.\r\n17: This game cannot be offered for sale because it has private servers enabled.\r\n18: The game price is outside of the allowed range.\r\n19: Invalid genre.\r\n20: The request body is missing.\r\n21: Invalid device type.\r\n22: Invalid asset type.\r\n23: Invalid value, the min must be less than or equal to the max\r\n24: Invalid scale value\r\n41: You cannot change the private server price again so soon after the previous change. Please try again later."
},
"401": {
"description": "0: Authorization has been denied for this request."
},
"403": {
"description": "0: Token Validation Failed\r\n2: You are not authorized to configure this universe.\r\n14: You are not authorized to sell games."
},
"409": {
"description": "9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted."
}
},
"servers": [
{
"url": "https://develop.roblox.com"
}
],
"x-roblox-stability": "EXPERIMENTAL",
"x-roblox-engine-usability": {
"apiKeyWithHttpService": false
},
"security": [
{
"roblox-legacy-cookie": []
}
],
"externalDocs": {
"url": "https://create.roblox.com/docs/cloud/reference/features/universes#develop_patch_v1_universes__universeId__configuration"
},
"x-roblox-recommended-alternatives": [
{
"url": "https://develop.roblox.com/v2/universes/{universeId}/configuration",
"httpMethod": "PATCH",
"documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/universes#develop_patch_v2_universes__universeId__configuration"
}
]
}