PATCH /v1/places/{placeId} — openapi

Updates the place configuration for the place with the id placeId

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

Endpoint

Method: PATCH

Path: /v1/places/{placeId}

Servers:

https://develop.roblox.com

Parameters

Name	Location	Required	Description
placeId	path	true	The place id for the place to be updated.

[
  {
    "in": "path",
    "name": "placeId",
    "description": "The place id for the place to be updated.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

{
  "$ref": "#/components/requestBodies/Roblox.Api.Develop.Models.PlaceConfigurationModel"
}

Responses

Status	Description
200	OK
400	placeId is invalid.
401	0: Authorization has been denied for this request.
403	Authenticated user is not authorized to manage this place. 0: Token Validation Failed

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaceModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaceModel"
        }
      }
    }
  },
  "400": {
    "description": "placeId is invalid."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "Authenticated user is not authorized to manage this place.\r\n0: Token Validation Failed"
  }
}

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": {}
        }
      }
    }
  }
}

Roblox.Api.Develop.Models.PlaceModel

components/requestBodies/Roblox.Api.Develop.Models.PlaceConfigurationModel

Complete Operation Definition

{
  "tags": [
    "Places"
  ],
  "summary": "Updates the place configuration for the place with the id placeId",
  "description": "Currently the only supported functionality for updating the configuration is around Name, and Description.",
  "parameters": [
    {
      "in": "path",
      "name": "placeId",
      "description": "The place id for the place to be updated.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "$ref": "#/components/requestBodies/Roblox.Api.Develop.Models.PlaceConfigurationModel"
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaceModel"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaceModel"
          }
        }
      }
    },
    "400": {
      "description": "placeId is invalid."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "Authenticated user is not authorized to manage this place.\r\n0: Token Validation Failed"
    }
  },
  "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/places#develop_patch_v1_places__placeId_"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://develop.roblox.com/v2/places/{placeId}",
      "httpMethod": "PATCH",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/places#develop_patch_v2_places__placeId_"
    }
  ]
}