Review routes: update · StartupBuilder

Reference for Review, one group of Review routes.

Review.update

Changes the given properties of a Review. Verb page.

Text

PATCH /{namespace}/reviews/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "review": {
    "$id": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
    "$type": "Review",
    "rating": 1,
    "status": "submitted"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Review.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Review.updateCopy Anchor Link

Review.update