Create report-schedule
POST
/report-schedules
Create a new report-schedule
Parameters
Header Parameters
compatibility-date*
API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.
Type
Requiredstring
Example
"2025-11-01"Pattern
"^\\d{4}-\\d{2}-\\d{2}$"organization-id*
Type
Requiredstring
Min Length
1Max Length
40Request Body
application/json
One of
object
disabled
boolean
Default
falsereportCreateData
object
Required
scheduleType
const:daily
Required
minute
number
Default
0Minimum
0Maximum
59hour
number
Default
0Minimum
0Maximum
23object
disabled
boolean
Default
falsereportCreateData
object
Required
scheduleType
const:weekly
Required
minute
number
Default
0Minimum
0Maximum
59hour
number
Default
0Minimum
0Maximum
23dayOfWeek
number
Required
Minimum
1Maximum
7object
disabled
boolean
Default
falsereportCreateData
object
Required
scheduleType
const:monthly
Required
minute
number
Default
0Minimum
0Maximum
59hour
number
Default
0Minimum
0Maximum
23dayOfMonth
number
Required
Minimum
1Maximum
31Responses
success.report-schedule.create
application/json
object
success
const:true
Required
reportSchedule
object
Required