Jump to Content

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.

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

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

Method	Endpoint	Description
`POST`	Create an account	Create a new account under the authenticated partner together with its owner user/person, links an account-level plan, sends the owner a set-password welcome email, and (when `with_location=1`) auto-creates one location-account + store on that plan.
`POST`	Import accounts and locations from a spreadsheet	Bulk-imports accounts from a single CSV — one account + one location per row — designed for up to ~100K rows.
`GET`	Check import status	Get live progress and the final outcome of a bulk account+location import (Bulk import accounts + locations (CSV upload)).
`GET`	List your accounts	Get a paginated list of accounts under the authenticated partner, with owner email, status, location/active-plan counts and current plan name.
`GET`	Get one account	Get a single account with everything the account-edit form needs: account row + company_options + city/state/country, the owner (name/email/phone), and the account's current plan_id.
`GET`	Get an account's plan	Get the account company record plus the plan currently assigned to it (with the plan's features and review-site profile included), or `plan: null` when no plan is assigned.
`GET`	Find accounts without an active plan	Get a paginated list of accounts under the authenticated partner that have NO active store-plan subscription, with owner email, cancelled-location count and last plan name.
`POST`	Edit an account	Update an existing account company row plus its owner user/person and account company_options.
`POST`	Assign or change an account's plan	Assign a plan to an account and propagates it to every store under that account: existing active/expired store_plans are closed and a fresh active store_plan (running to month-end) is created per store, and the account-level `company_plans` link is updated/created.
`DELETE`	Delete an account and everything under it	Soft-delete an account and cascades to everything beneath it — its location-account companies, their stores, and each store's reviews/responses/flags/review-site rows; open plans are closed.