opschain entity update
Included from Basic tier
opschain entity update <entity-path> [--name <name>] [--description <text>] [--archived=bool]
Updates one entity's attributes. Only the flags you pass are sent;
everything else keeps its stored value. The code is immutable — the path
is the entity's identity. --archived archives the entity and
--archived=false unarchives it; an archived entity stays readable and
keeps its history.
opschain entity update shop/environments/prod/entities/orders_schema --description "Orders, v2 layout"
updated entity /projects/shop/environments/prod/entities/orders_schema (0193b7aa-…)
You need update rights on the entity's path; without them it answers as
not found. -o, --output json|yaml emits the updated entity.
Flags
| Flag | Meaning |
|---|---|
--name <name> | New display name (must not be blank). |
--description <text> | New description; an empty value clears it. |
--archived | Archive (--archived) or unarchive (--archived=false). |
Exit codes
| Code | Meaning |
|---|---|
| 0 | Updated. |
| 1 | The server refused — not found, or a named field refusal such as a name already used by a sibling. |
| 2 | Usage error — no flag given (nothing to update — pass at least one of --name, --description or --archived), a blank --name, an empty path, no server target. |