Catalog options
A standardized, reusable value that classifies items and defines status codes and controlled lists in all modules.
- API name:
options - Domain: Features
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Position | rank | Order rank | Yes | |
| Name | label | Text I18n | ||
| Value | value | Text | Yes | Stored value for this option row in the database. |
| Color | color | Color | Yes | |
| Description | description | Text Area I18n | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Actions
What you can do with a record. Every action also sends the webhook event options.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new option. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this option. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this option. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this option again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this option from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this option to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this option and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |