Skip to main content
POST
Create or amend a report schedule.

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

Create or amend a report schedule. Everything the enqueue would refuse is refused here instead. A PDF or a spreadsheet carries the report's chart unless the schedule leaves it out; a CSV carries the table only.

p_report_definition_id
string<uuid>
required
p_cadence
string<text>
p_day_of_month
integer<integer>
p_day_of_week
integer<integer>
p_format
string<text>
p_hour_utc
integer<integer>
p_id
string<uuid>
p_include_chart
boolean<boolean>
p_is_active
boolean<boolean>
p_recipients
string<jsonb>

Response

200

OK