Skip to content
CLIProductWhat you sellProduct

Product commands: update, delete

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

Reference for Product, one group of Product commands.

Product.update

Changes the given properties of a Product. Verb page.

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

Emits Product.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Product.
namestringThe name of the Product.
promisetextWhat the Customer can rely on.

Returns

OutputTypeRequiredDescription
productProductrequiredThe Product.

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 Product.update --json '{"id":"prod_MJmgS5dysq","name":"Leaseline"}'

Product.delete

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

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

Emits Product.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Product.

Returns

OutputTypeRequiredDescription
productProductrequiredThe Product.

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