Add and manage locations

Add the locations that belong to an account, and manage them over time.

Add the locations (stores, offices, branches, service areas) that belong to an account, and manage them over time.

A location is where reviews actually attach. Each one belongs to one account, inherits that account's plan when it's created, and gets an empty slot for each review site on the plan, ready for you to connect (see Connect review sites).

Who can do what: partners create, edit, and remove locations. Account users can list and view the locations they have access to, and update existing ones from a spreadsheet.

Adding a lot at once? If you're creating accounts and locations together, use Import accounts and locations from a spreadsheet on the Accounts page. To add many locations to an account that already exists, use Upload locations for review below.

You'll need the account's id to create a location, and the location's store_id (or your own client_location_id) for everything else.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

Add a location

POST — Add a new location under an account.

Open →

List all locations under your partner

GET — Get every location across every account under your partner, with its account name, address, and current plan.

Open →

List an account's locations

POST — Get the locations the calling user can access, with full address, account, plan and plan features, and a ready-made link to each location's connection page.

Open →

List locations for a menu

GET — Get a simple name/id list of the locations the calling user can access.

Open →

Get one location

GET — Get a single location with its account, address, and current plan.

Open →

Edit a location

POST — Change a location's name, label, your client_location_id, address, website, or phone numbers.

Open →

Remove a location

DELETE — Remove a location and everything attached to it: its reviews, responses, flags, and review site connections.

Open →

Download the locations spreadsheet template

GET — Get a link to the sample spreadsheet for adding locations in bulk.

Open →

Upload locations for review

POST — Upload a spreadsheet of new locations for an account.

Open →

Update existing locations from a spreadsheet

POST — Update details of locations you already have — name, label, address, city, postal code — from a spreadsheet, matched to each location by its id.

Open →


Did this page help you?