Delete an account email report

Overview

Delete an account email report and all of its associated rows — recipients, store links, user links, and account links — along with the report itself. All deletions run inside a single database transaction, so if any step fails, the report is left unchanged.

Prerequisites

• Obtain a bearer token for an account-tier user.
• Note the report_id of the report you want to delete. The report must belong to your own account or an account beneath it in your hierarchy.

Base URL

Endpoint

DELETE /api/v1/user/reports/delete

Authentication

• Pass your bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• This endpoint sits under the user/* group and requires an account-tier user.

• Tokens from any other tier receive a 403.

• The report named in report_id must belong to your own account or to an account beneath it in your hierarchy.

• Requests for reports outside that hierarchy also return a 403.

Rate limit

This endpoint has no rate limit.

Request body

Send the report to delete as JSON in the request body.

{
  "report_id": 42
}

Response

• data.status (string) — success when the report is deleted.
• data.response (string) — the confirmation message Report has been deleted successfully!.

Success (200)

{
  "data": { "status": "success", "response": "Report has been deleted successfully!" }
}

Errors

A 500 response returns an error body instead of the success payload:

{
  "data": { "status": "error", "message": "..." }
}

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/user/reports/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"report_id": 42}'