Archive object type
archive_objectSoft-delete (archive) a custom object type by key. Existing records are kept but the object disappears from the registry. Built-in objects can't be archived. Returns the archived object.
When to use: When an admin no longer needs a custom object. Existing records are kept; the object leaves the registry.
Example: We don't track Listings anymore — archive that object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | The custom object's stable key (from describe_schema). Built-in keys are refused. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| object | No |