Toggle scraper

Overview

Toggle data-pulling (sendto_scrapper Y/N) for a store's review site. Turning it off marks the row disconnected (data-pulling paused) and emails the owner, turning it on clears the pause.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

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

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Authenticate with a bearer token OR an invite hash.

• Authenticated callers send store_id (+ review_site_id), and store_id must pass an ownership check.

• With a hash (tokenless), store_id comes from the hash in prepareForValidation. Any client-supplied store_id is ignored.

• It differs per role only by reachable scope (Partner vs Account tree).

Rate limit

• 30 requests/min.

Request body

• Body:

{
  "review_site_id": 123,
  "store_id": 123,
  "sendto_scrapper": "Y",
  "review_site_url": "https://maps.google.com/?cid=6987565896915883812"
}

Response

• data.status (string) — success.
• data.message (string) — Review site enabled successfully or Review site disabled successfully. Returns 400 No Record Found! if no matching (store, review-site) row exists.

200 OK · 200

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

Errors

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": 123, "store_id": 123, "sendto_scrapper": "Y", "review_site_url": "https://maps.google.com/?cid=6987565896915883812"}'