Edit a partner email report

Overview

Change a scheduled report's frequency or the accounts it covers.

Use this when the team or needs change.

You'll need the report_id and the changes.

The schedule is updated.

Prerequisites

• A Partner bearer token. See Authentication.
• The report's report_id, from List scheduled reports.

Base URL

Endpoint

POST /api/v1/partner/reports/edit

Authentication

Partner token

• Only Partner tokens can call it. Any other token gets 403 (This action is unauthorized.).
• The report and every id in account must be inside your own tree; anything else is rejected with 422.
• The report type and recipient can't be changed here.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Request payload

{
  "report_id": 5,
  "reportPeriodType": "month",
  "all_account": 0,
  "account": [
    5994
  ]
}

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

403 Not a Partner token

{
  "message": "This action is unauthorized."
}

422 Report doesn't exist

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

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": "month", "all_account": 0, "account": [5994]}'