Settings
Schema Version: 1
Represent set of options used as settings or preferences.
Definition
| Property Name | Type | Required |
|---|---|---|
| scope | string | YES |
| options[]label | string | YES |
| options[]type | string|string[] | YES |
| options[]default | string | NO |
| options[]value | string | NO |
Auto-generated
| Property Name | Type |
|---|---|
| _id | string |
| updated_at | date |
| updated_by | string |
| schema_version | number |
Example
JSON
{
"_id": "123",
"scope": "user",
"options": [
{
"label": "Enable lock screen?",
"type": "boolean",
"default": false,
"value": true,
},
{
"label": "Lock screen pin",
"type": "string",
"default": null,
"value": "1234",
},
],
"updated_at": "2026-10-02 21:27:00+07",
"updated_by": "123",
"schema_version": 1,
}
Important Notes
Option types
The options[]type accepts "string", "number", "boolean", or "date". It also supports string[] for options with multiple choices.
Examples
Options for direction ["right", "left", "up", "down"] or priority ["low", "medium", "high"]
Value and defaults
The options[]default and options[]value properties can be null for option that do not have default value but cannot be undefined or missing.
