Edit an account email report

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

Auth: Account — authentication; 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:
FieldTypeRequiredNotes
report_idintegeryesMust be an existing report within the caller's account hierarchy.
reportPeriodTypestringyesday, week, or month;.
all_storeintegeryes1 = all stores, 0 = specific stores. Rule required|in:0,1.
store_idsint[]required_if all_store=0Store ids; each must exist and pass an ownership check.

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
store_ids
array of integers
store_ids
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