Connect a location to its review sites so reviews start coming in, customers can be sent to leave new ones, and responses can be posted back.
Connect a location to its review sites so reviews start coming in, customers can be sent to leave new ones, and responses can be posted back.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | List a location's review sites | List every review site configured for a store, each with its URL, review-collection flag, connection card-state and review-site metadata — drives the store's connection/listing page. |
GET | Get one site connection | Get the full detail bundle for one store-review-site row: the pivot record, its review-site, its store (+company), the site map, partner-specific flag, and the latest cadence pull summary — drives the edit-site page. |
POST | Set a site's URLs and credentials | Update a single store-review-site row's URL, landing page, credentials and site-specific extras (BBB / Caring / SeniorAdvisor fields), switches review collection on when a URL is present on an active store, and dispatches a pull job. |
POST | Disconnect response posting | Clear the credentials and site-specific detail for a store-review-site row, turns review collection off, marks it manually disconnected, and emails the account owner. |
POST | Turn review collection on or off | Toggle data-pulling (sendto_scrapper Y/N) for a store's review site. |
POST | Set landing page URLs in bulk | Backfills landing-page URLs for several of a store's review sites in one call. |
POST | Find sites missing a review URL | Returns a paginated grid of store-review-site rows in the caller's accessible tree that are missing their review-site URL and/or landing-page URL — drives the URL backfill grid. |
POST | Send the business owner a connection link | Emails a tokenized review-site connection invite for a store and echoes the connect URL + token so the UI can also show copy/resend. |
POST | Turn a landing page URL on or off | Toggle url_status (enable/disable) of a store's landing-page URL — drives the "Enable URL" column on the Landing Page grid. |
POST | List all URLs for a location | Unified paginated URL grid that powers both the "Review Sites" and "Landing Page" pages, each with an All / Missing tab. |
POST | Get the manager-invite address for a site | Drives the MANAGER_INVITE publisher connect flow for one store-review-site row (Yelp / TripAdvisor / Expedia / Booking.com / DoorDash / …): requires a completed review-pull first, then looks up or creates the publisher account and returns the business-manager alias to invite plus the live connection status. |
POST | List Review Sites by Invite Hash (PUBLIC) | PUBLIC endpoint hit by recipients of the review-site invite email: lists a store's review sites identified solely by the invite hash, returning the same row shape as the authenticated list endpoint plus the store name/id. |
POST | Change display-connected flag (non-prod) | Non-production only** (returns 403 on production). |