Skip to main content

Create Schedule

POST 
/api/v2/custom-reports/1/schedules

Create a new schedule.

Required fields:

  • frequency (string): daily, weekly, or monthly
  • time_of_day (string): H:i or H:i:s
  • recipients (array of valid emails, min 1)

Optional fields:

  • day_of_week (0-6) when frequency is weekly
  • day_of_month (1-31) when frequency is monthly
  • timezone (string, default UTC)
  • export_format (csv, xlsx, pdf, default csv)
  • is_active (boolean, default true)

Returns 201 with the schedule resource. Returns 403 if the caller is not the report owner.

Request​

Responses​

Successful response