Update Report Schedule

PUT 
/api/v2/custom-reports/:customReport/schedules/:schedule

Update a schedule. Only the owner can update schedules (403 otherwise). Every field is optional; changing any timing field recomputes next_run_at. time_of_day is returned as HH:MM:SS and accepted back in that form.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

• frequency: daily, weekly or monthly
• time_of_day: HH:MM or HH:MM:SS in timezone
• recipients: array of email addresses (min 1)
• day_of_week (integer 0-6, 0 = Sunday): send day for weekly
• day_of_month (integer 1-31): send day for monthly
• timezone (IANA timezone, default UTC)
• export_format: csv, xlsx or pdf (default csv)
• is_active (boolean, default true)

Returns 404 when the schedule does not belong to the report.

Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:write scope.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

404

Not Found

Response Headers

Content-Type

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.