Skip to content

Entitlement commands: update, delete

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

Reference for Entitlement, one group of Entitlement commands.

Entitlement.update

Changes the given properties of an Entitlement. Verb page.

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

Emits Entitlement.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Entitlement.
verbVerbThe Verb it grants.
limitLimitThe Limit that bounds it.
kindstringComputed, never set: feature, or limit when a Limit bounds it.

Returns

OutputTypeRequiredDescription
entitlementEntitlementrequiredThe Entitlement.

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 Entitlement.update --json '{"id":"ent_7MQACmrzGj","verb":"verb_hlkWBvrAyZ"}'

Entitlement.delete

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

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

Emits Entitlement.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Entitlement.

Returns

OutputTypeRequiredDescription
entitlementEntitlementrequiredThe Entitlement.

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 Entitlement.delete --json '{"id":"ent_7MQACmrzGj"}'