Change display-connected flag (non-prod)

Non-production only (returns 403 on production). Sets the display_as_connected flag on the (store_id, review_site_id) store-review-site row. When Y, the connection page shows the site as Connected without a live platform connection; enabling requires the row to already have a review_site_url. When N, the connected display is turned off.

Auth

  • Auth-optional (lives in the public store-review-site group). Either an authenticated admin/account bearer token (store_id then scoped by an ownership check), OR an emailed invite hash (no token) — the store_id is then derived from the hash so a recipient can only toggle their own store. Blocked entirely (403) on production.

Rate limit

  • 30 requests/min per IP.

Body

FieldTypeRequiredNotes
review_site_idintegerRequiredMust be an existing review site.
store_idintegerRequiredMust be an existing location. Token flow: must be in caller's hierarchy (an ownership check). Hash flow: overridden by the store encoded in hash (any supplied value is ignored).
display_as_connectedstring (Y|N)RequiredY = mark connected (requires an existing review_site_url); N = turn off.
hashstringOptionalInvite hash (alphanumeric). When present, grants tokenless access and supplies store_id (must decode to entity type 15).

Behaviour

  • 200{ data: { status: 'success', message } } ('Review site marked as connected' / 'Connected display turned off').
  • 400 — no matching store-review-site row, or enabling without a stored review_site_url.
  • 403 — called on production (route disabled) or unauthorised.
  • 422 — validation failure.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
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