Toggle scraper

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.

Auth: Both — authentication OR 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 and any client-supplied store_id is ignored. Differs per role only by reachable scope (Partner vs Account tree).

Rate limit: 30 requests/min.

Request

  • Body:
FieldTypeRequiredNotes
review_site_idintegeryesMust be an existing review site.
store_idintegeryes (token flow)Must be an existing location inside your own account tree; ignored/overridden in the hash flow.
sendto_scrapperstring (Y/N)yesEnable/disable pulling.
hashstringhash flow onlyInvite hashid [store_id,15]; supplies store_id and grants tokenless access.

Response{ data. } envelope.

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

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
string
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json