Turn review collection on or off

Overview

Pause or resume collecting reviews from one site without removing its URL.

Use this to stop collecting from a site temporarily, or to turn it back on.

You'll need the location's store_id and the site's review_site_id. To turn on a site that has no review URL yet, send review_site_url too; it's saved in the same call.

When off, no new reviews are collected from that site. Existing reviews stay. Turning it off shows the site as disconnected (data pulling paused) and emails the account owner. Turn it back on with the same call.

Prerequisites

A bearer token, or the invite hash from a connection link. See Authentication.
The location's store_id and the review_site_id.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/store-review-site/change-scrapper-status

Authentication

Partner or Account token

store_id must be a location inside your own account tree. A Partner token reaches any location under the partner; an Account token only its own account's locations. Otherwise 422.
Or, with no token: send the invite hash (the token from Send the business owner a connection link). The location comes from the hash, and any store_id you send is ignored.

Rate limit

30 requests per minute, counted per client IP address. See Rate limits.

Request parameters

None.

Request body

Field	Type	Required	Description
`review_site_id`	integer	Yes	The review site. Must exist.
`store_id`	integer	No	The location. Required with a token; with a `hash` it comes from the hash. Must be inside your account tree.
`sendto_scrapper`	string	Yes	`Y` to turn review collection on, `N` to turn it off.
`review_site_url`	string	No	A valid URL. Saved whenever you send it. Required to turn on a site that has no review URL yet.
`hash`	string	No	The invite hash from a connection link, used instead of a token.

Request payload

{
  "review_site_id": 1,
  "store_id": 3007,
  "sendto_scrapper": "Y",
  "review_site_url": "https://www.yelp.com/biz/demo"
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`message`	string	`Review site enabled successfully` or `Review site disabled successfully`.

Response payload

{
  "data": {
    "status": "success",
    "message": "Review site enabled successfully"
  }
}

Examples

Success payload

Turned on: see Response payload.

Turned off:

{
  "data": {
    "status": "success",
    "message": "Review site disabled successfully"
  }
}

Error payload

400 The location doesn't have that review site

{
  "message": "Bad Request",
  "status": "error",
  "errors": {
    "message": "No Record Found!"
  }
}

422 Missing fields

{
  "message": "The review site id field is required. (and 2 more errors)",
  "errors": {
    "review_site_id": [
      "The review site id field is required."
    ],
    "store_id": [
      "The store id field is required."
    ],
    "sendto_scrapper": [
      "The sendto scrapper field is required."
    ]
  }
}

422 URL required when turning on

{
  "message": "The review site URL is required when enabling the review site.",
  "errors": {
    "review_site_url": [
      "The review site URL is required when enabling the review site."
    ]
  }
}

422 Invalid values or location outside your tree

{
  "message": "The selected store id does not belong to your company hierarchy. (and 2 more errors)",
  "errors": {
    "store_id": [
      "The selected store id does not belong to your company hierarchy."
    ],
    "sendto_scrapper": [
      "The selected sendto scrapper is invalid."
    ],
    "review_site_url": [
      "The review site url field must be a valid URL."
    ]
  }
}

422 Invalid hash

{
  "message": "Invalid or expired token.",
  "errors": {
    "hash": [
      "Invalid or expired token."
    ]
  }
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Status	Meaning
`200`	Review collection was turned on or off.
`400`	The location doesn't have that review site (`No Record Found!`).
`401`	No token and no `hash`, or the token is expired or invalid.
`422`	A field is missing or invalid, turning on without a review URL, the location is outside your tree, or the `hash` is invalid.
`429`	Rate limit exceeded.
`500`	Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/change-scrapper-status" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"review_site_id": 1, "store_id": 3007, "sendto_scrapper": "Y", "review_site_url": "https://www.yelp.com/biz/demo"}'