Delete account (cascade + dormant if enabled)

Overview

Soft-delete an account, cascading 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.

Prerequisites

• A bearer token. Callable with Partner tokens.
• The brandId of the record you are targeting.

Base URL

Endpoint

DELETE /api/v1/partner/account/{brandId}/delete

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.
• Who can call it: Partner tokens.
• Authentication is 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.

Path parameters

Response

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

200 Deleted · 200

{
  "data": {
    "status": "success",
    "message": "Account has been deleted successfully!",
    "account_id": 7
  }
}

422 Unknown / cross-tenant id · 422

{
  "message": "The selected account id does not belong to your company hierarchy.",
  "errors": {
    "account_id": ["The selected account id does not belong to your company hierarchy."]
  }
}

404 Not an account · 404

{
  "message": "Not Found",
  "status": "error",
  "errors": "Account not found."
}

Errors

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/account/123/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'