Update object type
update_objectAdmin-only patch of a custom object's label, plural, blurb, icon, shared-write mode, enabled flag or display_field (null resets to name). show_in_menu changes navigation only; hiding a menu row leaves the object usable. Built-in keys accept only enabled and show_in_menu. enabled:false hides records across the workspace and makes generic verbs refuse the object until re-enabled; nothing is deleted. Preview first, then confirm:true to disable; enabling needs no confirmation. describe_schema.switchable identifies objects that allow switching; foundational objects and feature parts do not. Returns the definition, or key and changes for a built-in/menu-only update.
When to use: An admin reconfigures an object type or its menu visibility.
Example: Rename the Property object to Listing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | The object's stable key (from describe_schema). On a built-in key only enabled and/or show_in_menu apply; any other change is refused. | |
| icon | No | A key from Capable's curated object-icon set (e.g. landmark, factory, handshake, flask); an unknown key is rejected with suggestions. Null clears back to the neutral default. | |
| blurb | No | New one-sentence description of the object; null clears it. | |
| label | No | New singular display name. The key does not change. | |
| plural | No | New plural display name for lists and the menu. | |
| shared | No | true lets any non-viewer edit every record of this object; false lets only the record's owner, admins and managers edit it. | |
| confirm | No | Required (true) to turn a BUILT-IN object off: the first enabled:false call answers with a preview instead. Not needed for anything else. | |
| enabled | No | false turns the object off (it leaves the schema and menu and the generic verbs refuse it; records kept); true turns it back on. On a built-in key, false needs confirm:true after a preview call. | |
| show_in_menu | No | Whether the object appears in the web app's sidebar menu — an explicit per-object override of the bounded default. Navigation only: it never changes what the object can do (that is `enabled`). Composes with the other args on a custom key; on a built-in key only with enabled. | |
| display_field | No | The data key holding a record's display name (a lowercase field key); null resets to the "name" default. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | ||
| note | No | ||
| label | No | ||
| object | No | ||
| updated | No | ||
| requires_confirm | No | ||
| records_affected_note | No |