Schedules

Update a schedule

Updates cadence, destination, or enabled state of a schedule. Send only the fields you want to change. Requires a session token.

put/schedules/{id}

Request

  • Base URL: https://saturnsql.com/api
  • URL: https://saturnsql.com/api/schedules/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring cuid required

Request body

cronExpressionstring
timezonestring
spreadsheetIdstring nullable
spreadsheetNamestring nullable
sheetNamestring nullable
startCellstring
includeHeadersboolean
enabledboolean
slackChannelIdstring nullable
slackChannelNamestring nullable
slackMessageTemplatestring nullable

Response

Updated

idstring
savedQueryIdstring
cronExpressionstring

5-field cron expression evaluated in timezone, e.g. '0 9 * * 1' for Monday 9am

timezonestring

IANA timezone, e.g. America/New_York

startCellstring

A1 notation anchor for the export

includeHeadersboolean
enabledboolean
nextRunAtstring date-time nullable
lastRunAtstring date-time nullable
lastErrorstring nullable
destinationType'sheets' | 'slack' nullable
spreadsheetIdstring nullable
spreadsheetNamestring nullable
sheetNamestring nullable
slackChannelIdstring nullable
slackChannelNamestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.