Update the specified task, whether it delivers a dashboard or a tab of a workbook. Changes to the schedule are applied to future runs. Currently running jobs are not affected.

<Note> A schedule's `entity` (dashboard or workbook) is set when the schedule is created and can't change. If the request body includes an `entity` value, it has no effect. </Note> <Warning> This endpoint replaces the schedule's entire configuration — it is not a partial update. The request must include every required field for the destination type. Any optional property left out of the request is reset to its default, not left at its current value. This includes `filterConfig` (filter values are cleared), `fanOut` (treated as `false`, unless your organization's [delivery personalization setting](/administration/content-permissions#delivery-personalization) is set to **Always**), `conditionType` and `conditionQueryMapKey` (the alert condition is removed), `queryIdentifierMapKey`, `containerPages` (selected pages are cleared), `maxRowLimit`, `textBody`, `filename`, and the paper and layout options.

The one exception is timezoneOverride: it keeps its current value when omitted, but only if query timezone overrides are enabled for the connection or document. Otherwise, it's cleared.

To change a single property, send the schedule's full configuration with that property changed. </Warning>

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

{
  "name": "Weekly Sales Report",
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York",
  "timezoneOverride": "Europe/Paris",
  "conditionQueryMapKey": "Jmn2r3KV",
  "conditionType": "RESULTS_PRESENT",
  "enableConditionalFormatting": true,
  "filterConfig": {
    "status": [
      "active",
      "pending"
    ]
  },
  "format": "pdf",
  "maxRowLimit": 1000,
  "paperFormat": "letter",
  "paperOrientation": "landscape",
  "queryIdentifierMapKey": "Jmn2r3KV",
  "containerPages": [
    "01KXH5TG58BB5JBJHGTPC62RZA"
  ],
  "showContentLink": true,
  "showFilters": true,
  "destinationType": "email",
  "filename": "weekly-sales-report",
  "subject": "Weekly Sales Report",
  "textBody": "Please find attached the weekly sales report."
}

{
  "scheduledTaskId": "123e4567-e89b-12d3-a456-426614174000",
  "success": true
}