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.
npx startup-builder do Review.update --json '<input>' [--try | --send | --do]Emits Review.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Review. |
rating | integer | The score, from 1 to 5. | |
body | text | The reviewer’s words. | |
venue | string | The venue it was posted on, by id; empty for the Startup’s own Site. | |
displayConsent | boolean | True once the reviewer agreed it may be shown on the Startup’s own Pages. Never randomized. | |
customer | Customer | The Customer who wrote it, when known. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Review.update --json '{"id": "review_1XPL2xTlfx", "rating": 1}'