Set the review URL for a site, and optionally its landing page URL and the login credentials used for posting. This is the step that starts review collection: as soon as a URL is saved on an active location, collection is switched on and a first collection is queued. Identify the connection one of three ways: store_review_site_id, or store_id + review_site_id, or client_location_id + review_site_id. Then send the url, and optionally landing_page_url (defaults to url), username and password. A few sites need extra fields (BBB, Caring, SeniorAdvisor). Important: this call replaces the whole connection, not just the fields you send. If you leave out url, the URL is cleared and collection stops, so always send the url.
Prerequisites: a bearer token (or the invite hash from a connection link) and the connection: its store_review_site_id, or the location plus review_site_id.
Authentication: Partner or Account token. The connection must be on 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. client_location_id is looked up only among the locations your token can reach. Or, with no token, send the invite hash with store_review_site_id; the connection must be on the location the hash is for.
Rate limit: 30 requests per minute, counted per client IP address.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||