Skip to content

by Startups.Studio

Review.create

POST /{namespace}/reviews

Creates a Review.

Noun: Review
Mode: do
Event: Review.created

You, to your agent

Add a review to PetPantry.

curl -X POST https://api.sb/petpantry.shop/reviews \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":1}'

import { $ } from 'startup-builder'

const review = await $.Review.create({ rating: 1 })

npx startup-builder do Review.create --json '{"rating":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Review.create({ rating: 1 })"
  }
}

Create makes a new Review from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`rating`	`integer`	required	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.
`offer`	Offer		A Review evaluates one Offer; Reviews of a Product or Brand roll up through its Offers.

Outputs

Output	Type	Required	Description
`review`	Review	required	The Review.

Effects

Emits Review.created.
Two-way: try, send, do.

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.	Review.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Review

Previous Page

Review.get

Next Page