Skip to content

Policy commands: update, delete

The Policy Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Policy, one group of Policy commands.

Policy.update

Changes the given properties of a Policy. Verb page.

Text
npx startup-builder do Policy.update --json '<input>' [--try | --send | --do]

Emits Policy.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Policy.
ruletextThe ruling, stated so code can apply it.

Returns

OutputTypeRequiredDescription
policyPolicyrequiredThe Policy.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Policy.update --json '{"id":"policy_rTYxr62HGB","rule":"Example rule"}'

Policy.delete

Deletes a Policy: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Policy.delete --json '<input>' [--try | --send | --do]

Emits Policy.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Policy.

Returns

OutputTypeRequiredDescription
policyPolicyrequiredThe Policy.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Policy.delete --json '{"id":"policy_rTYxr62HGB"}'