Edit partner email report

Overview

Update an existing partner email report's frequency and account targeting; report type and recipient are not changed here.

Prerequisites

• A bearer token. Callable with Partner tokens.

Base URL

Endpoint

POST /api/v1/partner/reports/edit

Authentication

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

• Who can call it: Partner tokens.

• Mounted under the partner/* group (partner-admin scope, no Hipages gate).

• Targeting must sit inside your own account tree, keyed on each account.* id (must be a company within the partner's own tree).

• The presence of report_id switches into edit-mode rules (report existence + period validated, recipient fields not required).

Rate limit

• No rate limit.

Request body

• Body:

{
  "report_id": 5,
  "reportPeriodType": "week",
  "all_account": 0,
  "account": [
    10,
    11
  ]
}

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/partner/reports/edit" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"report_id": 5, "reportPeriodType": "week", "all_account": 0, "account": [10, 11]}'