Place

Attributes

pathstring
createTimestring
updateTimestring
displayNamestring
descriptionstring
serverSizenumber
Base URL
https://apis.roblox.com/cloud
The Place Resource
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}

Place

Get Place

GET /v2/universes/{universe}/places/{place}
RequestPath Parameters
universestringRequired
placestringRequired
ResponsePlace
GET /v2/universes/{universe}/places/{place}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/places/{place}' \

  -H 'x-api-key: {your-api-key}'
Response
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}

Place

Update Place

PATCH /v2/universes/{universe}/places/{place}
Scopes
universe.place:write
RequestPath Parameters
universestringRequired
placestringRequired
Query Parameters
updateMaskstring
Request BodyPlace
ResponsePlace
PATCH /v2/universes/{universe}/places/{place}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/places/{place}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  -d  \

  '{

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}'
Response
{

  "path": "universes/123/places/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "displayName": "ROBLOX Battle [OPEN]",

  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",

  "serverSize": "integer"

}