Edit an account email report

Overview

Update an existing account email report's frequency and store assignments (recipient and report type unchanged).

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

POST /api/v1/user/reports/edit

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Mounted under the user/* group.

• Requires the auth user's company (account user only, else 403).

• store_ids.* must sit inside the caller's company tree.

• Existing report_stores rows get deleted, then re-inserted.

Rate limit

• No rate limit.

Request body

• Body:

{
  "report_id": 5,
  "reportPeriodType": "week",
  "all_store": 0,
  "store_ids": [
    1
  ]
}

Response

• data.status (string) — success.
• data.response (string) — message Report has been updated successfully!.

200 Success · 200

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

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/user/reports/edit" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"report_id": 5, "reportPeriodType": "week", "all_store": 0, "store_ids": [1]}'