Account
Endpoints runnable with an ACCOUNT access token — locations, plans, review sites, reviews & responses, campaigns, QR codes, FAQ/widgets, white-label, email templates.
Endpoints runnable with an ACCOUNT access token — locations, plans, review sites, reviews & responses, campaigns, QR codes, FAQ/widgets, white-label, email templates. Reports live under 'Report Endpoints'.
Terminology
These docs use one name per concept. Where the field name differs, it is given here.
| Term | What it means | Field name |
|---|---|---|
| Partner | The top-level tenant. Reaches every account and location beneath it. | partner_id |
| Account | A business within a partner. Owns locations, campaigns and reports. | account_id |
| Location | A single site with its own review-site connections and reviews. | store_id |
brand appears in some field names and status values as the older name for an account, and store as the older name for a location. They refer to the same records.
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.
In this section
Master review-site catalogue lookup, bulk credential updates across an account, Excel export / import, credential cleanup.
Account-initiated review flagging — create a flag, check status, read history, fetch the reason catalogue.
SMS / email / generic / kiosk test sends — preview a review-request before launching the campaign.
List / get / update / delete / duplicate the QR codes an account uses for in-person review solicitation.
Public scan endpoint — receives the in-person QR scan event and pings the review-request flow.
Account self-service: company FAQ blocks, testimonials, gallery images, and review widgets.
Per-account email-template customization (copy, regions, delivery method, logs, test sends).
Public, unauthenticated links embedded in review-solicitation emails/SMS and landing pages — hit directly by end customers (and their mail clients) via Hashids-encoded codes/tokens, not by the SPA.
Account-token CRUD for campaign email templates (campaign/template/email/*, authentication, no throttle).
Account-token (and partner) CRUD for campaign landing-page templates (campaign/template/landing-page/*, authentication, no throttle).
Account-token CRUD for campaign SMS templates (campaign/template/sms/*, authentication, no throttle).
Account-token management of automation campaigns and their upload file-header (column-mapping) configurations, called by account users.
Auth-optional Google Business Profile and Facebook page connection endpoints for a store's review sites.
Endpoints that power the embeddable review widget: fetch a widget's config/feed by unique_id, record view/click activity, and list available widget types.
Account/partner billing-address management and the partner-level checkout preview.
Updated 14 days ago