Skip to main content

Create Report Schedule

POST 
/api/v2/custom-reports/:customReport/schedules

Email a report on a recurring schedule. Only the owner can create schedules (403 otherwise). next_run_at is computed from the timing fields.

Required scope: reports:write

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

Body (frequency, time_of_day and recipients are required):

  • 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 201 with the schedule in data.

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

Request​

Responses​

Created

Response Headers
    Content-Type