UpdateReportRequest
A request or response body; the type column links to the schemas it refers to.
UpdateReportRequest
Fields to change; an omitted field is left as it is.
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | What the report is called, in its emails and on its page. 1–120 characters |
| enabled | boolean | no | — |
| cadence | string | no | `daily`: every day at `hour`. `weekly`: on `weekday` at `hour`. `monthly`: on the first of each month at `hour`. Hours are on the deployment's clock (`time_zone`). one of "daily" | "weekly" | "monthly" |
| weekday | integer | no | Day of the week, 0 = Sunday … 6 = Saturday; read only when weekly. minimum 0 · maximum 6 |
| hour | integer | no | Hour of the day, 0–23, on the deployment's clock. minimum 0 · maximum 23 |
| role_ids | array of string (uuid) | no | Replaces the roles. 1–100 items |
| recipient_ids | array of string (uuid) | no | Replaces the recipients. at most 50 items |
| exclusions | array of string | no | Replaces the exclusions; `[]` leaves nobody out. at most 20 items |
| contents | any | no | — |
jsonExample
{
"name": "Weekly forklift operator progress",
"enabled": true,
"cadence": "weekly",
"weekday": 1,
"hour": 7,
"role_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"recipient_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"exclusions": [
"@botreeinc.com"
],
"contents": null
}