PATCH /cloud/v2/universes/{universe_id}/places/{place_id} — cloud.docs

Update Place

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.

Endpoint

Method: PATCH

Path: /cloud/v2/universes/{universe_id}/places/{place_id}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
place_id	path	true	The place ID.
updateMask	query	false	The list of fields to update.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "place_id",
    "in": "path",
    "description": "The place ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "updateMask",
    "in": "query",
    "description": "The list of fields to update.",
    "schema": {
      "type": "string",
      "format": "field-mask"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Place"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Place"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Place

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Update Place",
  "description": "Updates the specified place. To avoid overwriting changes, this endpoint\nresponds with an HTTP 409 Conflict error if the place is open in an\nactive Team Create session.",
  "operationId": "Cloud_UpdatePlace",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "place_id",
      "in": "path",
      "description": "The place ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "The list of fields to update.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Place"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Place"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Universes and places",
    "methodProperties": {
      "scopes": [
        "universe.place:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/Place",
      "name": "Place"
    }
  }
}