Schedules

Replace a scheduled task's configuration. Changes apply to future runs; jobs that are already running are not affected. This is a full replacement, not a partial update: the request must include every required field for the destination type, and any optional property left out is reset to its default instead of keeping its current value. That includes filterConfig (filter values are cleared), fanOut (treated as false, unless your organization always personalizes deliveries), conditionType and conditionQueryMapKey (the alert condition is removed), queryIdentifierMapKey, maxRowLimit, textBody, filename, containerPages (pdf and png fall back to the dashboard's first page; csv and xlsx fall back to every tile), and the paper and layout options. The one exception is timezoneOverride, which keeps its current value when omitted, as long as query timezone overrides are enabled for the connection or document. To change a single property, send the schedule's full configuration with that property changed.

put/api/v1/schedules/{scheduleId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/schedules/{scheduleId}
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Example:123e4567-e89b-12d3-a456-426614174000

Request body

OR
OR
OR
OR

Example request

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

Response

Schedule updated successfully

scheduledTaskIdstring uuid required

The UUID of the updated scheduled task

successboolean required

Whether the operation was successful

Example response

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

Changes

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • breaking

      added subschema #1 subschema #2 to the request body allOf list

    • warning

      removed subschema #1 subschema #2 from the request body allOf list