Update schedule
Update the specified task. Changes to the schedule are applied to future runs; currently running jobs are not affected.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the schedule. To find a schedule's ID:
- Navigate to the dashboard or workbook.
- Click File > Deliveries & Alerts.
- Next to a schedule, click Edit.
The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:
Body
- Email
- Webhook
- SFTP
- Slack
- S3
When the task runs, as an AWS EventBridge cron expression (minute hour day-of-month month day-of-week year).
Runs cannot be more frequent than once an hour unless the organization allows a higher frequency. Delivery times are approximate and happen within 15 minutes of the scheduled time.
"0 9 ? * MON *"
Optional IANA timezone applied to query execution at render time. Distinct from timezone, which controls when the schedule fires.
Pass null to clear it (use the default). Omitting keeps the current value only while query timezone overrides are enabled for the connection or document; otherwise it is cleared.
"Europe/Paris"
Compatible with pdf and png formats. If true, AI summary tiles grow to show their full text, splitting across pages when paperFormat isn't fit_page.
With paperFormat: fit_page, the page grows instead, and the operation fails if the page would be taller than 60,000px.
Not supported for app deliveries.
false
Dashboard deliveries only. An object specifying the filter conditions to apply to the task. The filter key specified must already exist in the dashboard.
Use the Get dashboard filters and controls endpoint to retrieve filter configuration objects.
Note: Filter keys are case-sensitive and must match exactly.
Compatible with csv and xlsx formats. If true, fields marked as hidden won't be displayed in the task's output. Not supported for app deliveries.
false
Required for single tile tasks and for workbook deliveries (entity: workbook). The ID of the query to include in a single tile task, or the ID of the workbook tab to deliver. Must reference a valid query in the document.
Required for:
format: jsonwithenableFormatting: trueformat: xlsxwithoverrideRowLimit: trueentity: workbook
"Jmn2r3KV"
Dashboard deliveries only. Compatible with pdf, png, csv, and xlsx formats, on dashboards using the advanced (multi-page) layout. The instanceKeys of the pages to render:
pdfrenders the listed pages in storage order.pngrenders each listed page as its own image, up to 10 pages. Deliveries that carry a single file (Slack, webhook, SFTP, S3, and downloads) get a zip with one PNG per page; email deliveries show the pages inline, in dashboard order.csvandxlsxkeep only the tiles on the selected pages.
Cannot be combined with queryIdentifierMapKey. Defaults to the dashboard's first page for pdf and png, and to every tile for csv and xlsx.
1If true, allow scheduled queries to use cached results instead of always running fresh queries. An alert always runs its condition check fresh. Only the delivery sent once the condition is met uses cached results.
Cannot be combined with rebuildExtracts. Not supported for app deliveries.
false
Applicable to email destinations. If true, send individual emails to each recipient.
If your organization's delivery personalization setting is set to Never, fanOut is always persisted as false regardless of the submitted value. If set to Always, personalization is forced on for all deliveries. See Personalizing email deliveries for more information.
Note: Personalized deliveries aren't supported for connections that use OAuth sign-in. In this case, the delivery will fail.

