Delete an account and everything under it

Overview

Remove an account and all of its locations, along with their reviews, responses, flags, and review site connections. Open plans are closed. If your partner has dormant archiving turned on, each location is archived to dormant before removal so it can be recovered later.

Use this when a business leaves for good.

You'll need the account's id.

The account and everything under it are removed (or archived to dormant). Review collection and posting stop for all of them. Billing for those locations ends.

Prerequisites

• A Partner or Account token. See Authentication.
• The account's id (brandId).

Base URL

Endpoint

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

Authentication

Partner or Account token

• An Account token reaches only its own account.
• The account must exist and be inside your account tree; otherwise 422.
• An id in your tree that isn't an account (for example a location) returns 404.
• An account that belongs to another partner returns 403.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

403 Another partner's account

{
  "message": "Forbidden",
  "status": "error",
  "errors": "You do not have access to this account."
}

404 Not an account

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

422 Account doesn't exist

{
  "message": "The selected account id is invalid. (and 1 more error)",
  "errors": {
    "account_id": [
      "The selected account id is invalid.",
      "The selected account id does not belong to your company hierarchy."
    ]
  }
}

422 Account outside your tree

{
  "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."]
  }
}

Example request

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