Skip to content

by Startups.Studio

Review.remove

POST /{namespace}/reviews/{review}/remove

Remove takes a Review down for good when its author or its venue asks; the record is kept.

Noun: Review
Mode: do
Event: Review.removed

You, to your agent

Remove the latest review.

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

import { $ } from 'startup-builder'

const review = await $.Review.remove({ review: 'review_1', reason: 'authorRequest' })

npx startup-builder do Review.remove --json '{"review":"review_1","reason":"authorRequest"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Review.remove({ review: 'review_1', reason: 'authorRequest' })"
  }
}

Inputs

Input	Type	Required	Description
`review`	Review	required	The Review to take down.
`reason`	`string`	required	Who asked.

Outputs

Output	Type	Required	Description
`review`	Review	required	The Review, now `removed`.

Effects

Emits Review.removed.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.

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.remove

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.publish

Previous Page

Review.update

Next Page