Edit partner email report

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

Auth: Partner — authentication; 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:
FieldTypeRequiredNotes
report_idintegeryesMust exist in reports. Required to enter edit branch.
reportPeriodTypestringyesday, week, or month; validated against the existing report.
all_accountintegeryes1 = all accounts, 0 = specific accounts. Rule required|nullable|in:0,1.
accountint[]required_if all_account=0Account company ids; each must exist and pass an ownership check. Existing report_companies rows get deleted, then re-inserted.

Response{ data. } envelope.

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

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
integer
account
array of integers
account
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json