Review methods: update · StartupBuilder

Reference for Review, one group of Review methods.

Review.update

Changes the given properties of a Review. Verb page.

TypeScript

interface ReviewVerbs {
  update(input: ReviewUpdateInput, options?: SB.CallOptions): SB.Call<Review>
}

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

TypeScript

import { $ } from 'startup-builder'

const review = await $.Review.update({ id: 'review_1XPL2xTlfx', rating: 1 })