Custom fields let you attach arbitrary key-value string data to any account. This is useful for tracking notes, external IDs, workflow status, or any metadata you want to associate with an account that does not fit a built-in property. All endpoints on this page — includingDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/N3XT3R1337/RiftCE/llms.txt
Use this file to discover all available pages before exploring further.
/setalias, /setdescription, and /setgroup — require the WebServerAllowEditing permission, which is disabled by default.
Permission required for all endpoints on this page: WebServerAllowEditing
When WebServerAllowEditing is disabled, all endpoints on this page return:
GET /setalias
Sets the display-name alias for an account. When an alias is set, the Rift CE UI shows it instead of the Roblox username.Parameters
The Roblox username of the account to update.
The new alias value. Pass an empty string to clear the alias.
Response
true on success.GET /setdescription
Sets the free-text description note on an account.Parameters
The Roblox username of the account to update.
The new description value. Pass an empty string to clear the description.
Response
true on success.GET /setgroup
Assigns an account to a named group.Parameters
The Roblox username of the account to update.
The group name to assign. Pass an empty string to remove the account from its current group.
Response
true on success.GET /getfield
Reads one or all custom fields from an account.- With
Field: returns the value of that single field. - Without
Field: returns the entireFieldsdictionary for the account.
Parameters
The Roblox username of the account to read from.
The key of the custom field to retrieve. Omit this parameter to return all fields at once.
Response (single field)
The key name of the field that was requested.
The stored value. Returns an empty string if the key exists but has no value, or if the key has not been set.
Response (all fields)
Returns theFields dictionary object directly — an object where each key is a field name and each value is its stored string.
Examples
GET /setfield
Creates or overwrites a custom field on an account.Parameters
The Roblox username of the account to update.
The key name of the custom field. Must not be empty — a missing or empty
Field returns 400 Bad Request.The string value to store. Pass an empty string to store an empty value (different from removing the field).
Response
true on success.GET /removefield
Deletes a custom field from an account. The changes are saved to disk immediately.Parameters
The Roblox username of the account to update.
The key name of the custom field to remove. Must not be empty — a missing or empty
Field returns 400 Bad Request.Response
true on success. Returned even if the key did not previously exist.