Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthReview

Review routes: publish, remove, withhold

The Review Verbs publish, remove, withhold as api.sb routes, with inputs, result, refusals and an example.

Reference for Review, one group of Review routes.

Review.publish

Publish shows a Review on the Startup’s Pages with its rating counted, whatever the rating. Verb page.

Text
POST /{namespace}/reviews/{review}/publish

Path: review. Emits Review.published.

Inputs

InputTypeRequiredDescription
reviewReviewrequiredThe Review to show.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review, now published.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/publish \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
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.publish",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Review.remove

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

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

Path: review. Body, as JSON: the other inputs. Emits Review.removed.

Inputs

InputTypeRequiredDescription
reviewReviewrequiredThe Review to take down.
reasonstringrequiredWho asked.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review, now removed.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/remove \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"authorRequest"}'
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.remove",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Review.withhold

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

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

Path: review. Body, as JSON: the other inputs. Emits Review.withheld.

Inputs

InputTypeRequiredDescription
reviewReviewrequiredThe Review to withhold.
reasonstringrequiredWhy it is not shown.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review, now withheld.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/withhold \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"fake"}'
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.withhold",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update

Previous

Sequence

Next