Delete account (cascade + dormant if enabled)

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. If the owning partner has dormant archiving enabled, every affected store is archived to the dormant connection before removal.

Auth: Partner — authentication under partner/account. The request injects the path id as account_id and validates it as an existing account inside your own account tree. Controller then 404s if missing/not bundle_id=3, walks getParentCompany(brand,'partner') and enforces canManageBrand (super-admin or matching partner) else 403. The dormant toggle is read BEFORE the cascade because the parent walk no longer resolves once the account is soft-deleted.

Rate limit: No rate limit.

Request

Response{ data. } envelope.

  • status (string) — success.
  • message (string) — Account has been deleted successfully!.
  • account_id (integer) — the deleted account id.

Path params

ParameterTypeRequiredNotes
brandIdintegerRequiredDigits only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
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