Skip to content

by Startups.Studio

Review.withhold

POST /{namespace}/reviews/{review}/withhold

Withhold keeps a Review off display for one of five reasons, none of them its rating or its tone.

Noun: Review
Mode: do
Event: Review.withheld

You, to your agent

Withhold the latest review.

curl -X POST https://api.sb/routewise.dev/reviews/review_1/withhold \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"fake"}'

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`review`	Review	required	The Review to withhold.
`reason`	`string`	required	Why it is not shown.

Outputs

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

Effects

Emits Review.withheld.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.
Records the reason beside the Review, where every reader of the record sees it.

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

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

Previous Page

Sequence

Next Page