Skip to main content

​
Description

Sets a property value on a single Roblox instance identified by its path. The value is automatically converted from JSON format to the appropriate Roblox data type.

​
HTTP Endpoint

POST /tools/set_property

​
Parameters

​
path
string
required
The path to the instance (e.g., “game.Workspace.Part”)
​
property
string
required
The name of the property to set (e.g., “Name”, “Position”, “Transparency”)
​
value
any
required
The value to set. Will be automatically converted from JSON to the appropriate Roblox type.

​
Response

​
ok
boolean
Returns true if the property was successfully set
​
error
string
Error message if the operation failed (path not found, property doesn’t exist, invalid value, etc.)

​
Code Examples

​
Set a string property

{
  "path": "game.Workspace.Part",
  "property": "Name",
  "value": "MyPart"
}

​
Set a numeric property

{
  "path": "game.Workspace.Part",
  "property": "Transparency",
  "value": 0.5
}

​
Set a Vector3 property

{
  "path": "game.Workspace.Part",
  "property": "Position",
  "value": { "x": 10, "y": 5, "z": 0 }
}

​
Set a Color3 property

{
  "path": "game.Workspace.Part",
  "property": "Color",
  "value": { "r": 1, "g": 0, "b": 0 }
}

​
Example Response

​
Success

{
  "ok": true
}

​
Error

{
  "error": "Path not found: game.Workspace.NonexistentPart"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us