Turn review collection on or off

Pause or resume collecting reviews from one site without removing its URL. Send 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. When off, no new reviews are collected from that site and 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), the location's store_id and the review_site_id.

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 location comes from the hash.

Rate limit: 30 requests per minute, counted per client IP address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 1

The review site. Must exist.

integer
Defaults to 3007

The location. Required with a token; with a hash it comes from the hash. Must be inside your account tree.

string
enum
required
Defaults to Y

Y to turn review collection on, N to turn it off.

Allowed:
uri
Defaults to https://www.yelp.com/biz/demo

A valid URL. Saved whenever you send it. Required to turn on a site that has no review URL yet.

string
Defaults to 5oogfx

The invite hash from a connection link, used instead of a token.

Responses

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