Skip to content

Review commands: update

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

Reference for Review, one group of Review commands.

Review.update

Changes the given properties of a Review. Verb page.

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

Emits Review.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Review.
ratingintegerThe score, from 1 to 5.
bodytextThe reviewer’s words.
venuestringThe venue it was posted on, by id; empty for the Startup’s own Site.
displayConsentbooleanTrue once the reviewer agreed it may be shown on the Startup’s own Pages. Never randomized.
customerCustomerThe Customer who wrote it, when known.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review.

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 Review.update --json '{"id":"review_1XPL2xTlfx","rating":1}'