Create and manage accounts
Create the accounts your locations sit under, assign each one a plan, and manage them over time.
Create the accounts your locations sit under, assign each one a plan, and manage them over time.
An account is a business, a brand, or any grouping of locations that share a plan. Every location has to belong to an account, so this is the first thing you set up for a new customer. Only partners create, edit, or delete accounts; account tokens can't call these endpoints.
How plans work here: you assign a plan to an account, and every location under it gets that plan.
Use your own IDs: when you create an account or location you can attach your own identifier (client_account_id, client_location_id). Most endpoints accept it in place of ours, so you never have to store our IDs in your system.
Setting up one business with one location? Create an account with with_location=1 does it in a single call: account, first location, plan, and the owner's welcome email. Setting up hundreds? Use Import accounts and locations from a spreadsheet.
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 — Create a new account under your partner, with its owner (and its first location when with_location=1).
POST — Create many accounts and their first locations at once from a CSV, up to ~100,000 rows.
GET — See how a spreadsheet import is going: rows processed, succeeded, and skipped with reasons.
GET — Get every account under your partner, with owner, status, counts, and current plan.
GET — Get the full details of a single account: business info, owner, plan, and settings.
GET — See which plan an account is on: its features, limits, and the review sites it includes.
GET — List accounts whose plan was cancelled or expired, so you know which need a plan assigned.
POST — Put an account on a plan, or move it to another; every location under it inherits the change.
DELETE — Remove an account and all its locations, reviews, responses, flags, and connections.
Updated 18 days ago
