Skip to main content
PUT
Patch a scheduled report's cadence or recipients

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

ScheduledReport id to update.

Body

application/json
frequency
enum<integer>

New delivery cadence code: 0 daily, 1 weekly, 2 monthly, 3 quarterly, 4 semiannual, 5 annual, 6 once, or 14 biweekly.

Available options:
0,
1,
2,
3,
4,
5,
6,
14
Example:

2

start_date
string<date> | null

New first-run date. Validation: nullable|date.

Example:

"2026-06-01"

recipient_emails
string<email>[] | null

Replace the recipient list. Validation: nullable|array, each entry email.

Example:

Response

Schedule updated.

message
string
Example:

"Scheduled report updated successfully"

success
boolean
Example:

true