Apply one site login to many locations

Save a username and password for a review site and apply it to every location in an account at once. Use this when a business uses one login for all its locations on a site. The credentials are saved on every active or pending location in the account that already has that review site set up, and review collection is switched on for them; locations without that review site are skipped. With apply_to_future_stores Y the login is also saved once on the account, so locations added later inherit it.

Prerequisites: a bearer token, the account's id (account_id), the review site's id (review_site_id), and the site's username and password.

Authentication: Partner or Account token. account_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422.

Rate limit: none.

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.

string
required
length between 2 and 1000
Defaults to [email protected]

The site's username. 2–1000 characters; no < or >. Accepted and saved, but not used yet: posting responses with a site login isn't supported, so this doesn't connect posting. It will be supported for review sites whose auth_type is default in a future release.

string
required
length between 5 and 1000

The site's password. 5–1000 characters; no < or >. Stored as sent. Accepted and saved, but not used yet: posting responses with a site login isn't supported, so this doesn't connect posting. It will be supported for review sites whose auth_type is default in a future release.

integer
required
Defaults to 5994

The account. Must be an active account inside your account tree.

string
enum
Defaults to Y

Y or N. Y also saves the login once on the account, so locations added later inherit it. N or left out: only the existing locations are updated.

Allowed:
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