Connect review sites
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.
The sites available to a location are set by its plan. Each site connection has three independent parts, and you can set up any one without the others:
- Review URL. The public page the location's reviews live on (its Google Business Profile, Yelp page, etc.). Once it's set, review collection starts on your plan's schedule. This is all you need for review data.
- Landing page URL. A deeper link to the same site that drops a customer straight onto the "leave a review" form. This goes into your review-request emails and texts. If you don't set one, it defaults to the review URL.
- Response posting. Permission to post replies on the location's behalf. How you get it depends on the site: Google and Facebook use a sign-in link the business owner clicks; Yelp, TripAdvisor, Booking.com and similar use a manager invite (the owner adds an address we give you as a manager on their listing); most other sites use a saved username and password.
Fastest path for a new location: set the review URL (Set a site's URLs and credentials), then send the owner one invite (Send the business owner a connection link) that covers every site on the location. They open your branded connection page and authorize what they want.
You'll need the location's store_id (or your own client_location_id) and the review site's ID from the Site catalogue. Most calls also accept the store_review_site_id of a specific connection, which you get from List a location's review sites.
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
POST — Get every review site on a location with the state of each connection: whether it has a review URL, whether collection is on, and whether posting is authorized.
GET — Get the full details of one review site connection on a location.
POST — Set the review URL for a site, and optionally its landing page URL and the login credentials used for posting.
POST — Email the business owner a link to your branded connection page, where they authorize response posting for the location's sites: sign in to Google or Facebook, or follow the manager-invite steps for Yelp and similar.
POST — For sites that authorize posting by manager invite (Yelp, TripAdvisor, Expedia, Booking.com, DoorDash and others), get the address the business owner needs to add as a manager on their listing, and check whether they've done it yet.
POST — Set the landing page URL (the deep link customers use to leave a review) for many sites or locations at once.
POST — Get the review URL and landing page URL for every site on a location in one call.
POST — Enable or disable a landing page URL without deleting it.
POST — Pause or resume collecting reviews from one site without removing its URL.
POST — List every site on a location, or across your account, that has no review URL yet.
Updated 24 days ago