--- title: "Update a workbook schedule" method: PATCH path: "/v2/workbooks/{workbookId}/schedules/{scheduleId}" tags: ["Workbooks"] --- # Update a workbook schedule `PATCH /v2/workbooks/{workbookId}/schedules/{scheduleId}` ## Request - Base URL: `https://api.sigmacomputing.com` - URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/schedules/{scheduleId}` - Auth: HTTP bearer Update a schedule of a workbook to export data from the workbook on a periodic basis. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint. - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. ## Path parameters - `workbookId` string, required - `scheduleId` string, required ## Request body - object - `target` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaTargetItems[]: One or more targets to send the workbook to. - `teamId` string: Unique identifier of the team to export to - `email` string: Email address to export to - `ccEmail` string: Email address to add as a Cc recipient - `bccEmail` string: Email address to add as a Bcc recipient - `ccTeamId` string: Unique identifier of the team to add as a Cc recipient - `bccTeamId` string: Unique identifier of the team to add as a Bcc recipient - `slackConversationId` string: Slack channel ID or member ID to export to - `googleSpreadsheetUrl` string: URL of the Google Sheet to export to - `googleDriveFolderUrl` string: URL of the Google Drive folder to export to - `webhookUrl` string: URL of the webhook endpoint to export to - `schedule` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSchedule: When to send the workbook export. - `cronSpec` string: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - `timezone` string: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. - `configV2` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2: Configuration settings for the export schedule. - `title` string: Title of the message - `messageBody` string: Body of the message - `exportAttachments` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems[]: Attachments to include in the export - `formatOptions` union, required: Export format options - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0: CSV export format options - `type` 'CSV', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1: JSONL export format options - `type` 'JSONL', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2: JSON export format options - `type` 'JSON', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3: XLSX export format options - `type` 'XLSX', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4: PDF export format options - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5: PNG export format options - `type` 'PNG', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6: No export format options - `type` 'NONE', required - `workbookExportSource` union, required: Workbook export source options - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0: Export multiple elements - `type` 'element', required - `elementIds` string[], required: Array of element identifiers to export - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1: Export multiple pages - `type` 'page', required - `pageIds` string[], required: Array of page identifiers to export - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2: Export all content - `type` 'all', required - `exportName` string: Name of the scheduled export - `includeLink` boolean: Include a link to the exported workbook - `runAsRecipient` boolean: Run the export queries as the recipient - `attachmentSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings: Export attachment settings - `mergeAttachments` boolean: Combines multiple PDF or XLSX attachments into a single file - `zipAttachments` boolean: Send attachments as a .zip file - `workbookVariant` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant: Workbook variant - `tagId` string: Version tag to export - `bookmarkId` string: Saved view (formerly called a bookmark) to export - `conditionOptions` union: Export condition options - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0: Always send the export - `type` 'always', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1: Send the export based on a condition - `type` 'workbook', required - `condition` union, required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0: If there's no data - `type` 'isEmpty', required: Type of condition - `elementId` string, required: ID of the element - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1: If there's data - `type` 'isNotEmpty', required: Type of condition - `elementId` string, required: ID of the element - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2: If a condition is met - `type` 'column', required: Type of condition - `elementId` string, required: ID of the element - `columnId` string, required: ID of the column - `op` 'Equals' | 'GreaterThan' | 'GreaterThanEq' | 'LessThan' | 'LessThanEq' | 'NotEquals' | 'IsNull' | 'IsNotNull' | 'Contains' | 'StartsWith' | 'EndsWith', required: Operator - `mode` 'any' | 'all', required: Kind of condition evaluation - `value` union: Column value - … - `workbookSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings: Workbook settings - `controlValues` object: This object maps control IDs to the values that they should have when exporting the workbook. - `language` 'de' | 'en' | 'es' | 'fr' | 'it' | 'ja' | 'pl' | 'pt' | 'ru' | 'th' | 'en-au' | 'en-ca' | 'en-gb' | 'en-ie' | 'es-mx' | 'fr-ca' | 'ko-kr' | 'nl-nl' | 'pt-br' | 'sv-se' | 'tr-tr' | 'zh-cn' | 'zh-tw': The locale identifier corresponding to the language of the translation. - `languageVariant` string: The name of the custom translation variant. - `formatting` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2Formatting: Export formatting options - `pivotHeaderStyle` 'merged' | 'repeated': Style of pivot table headers - `includeMetadata` boolean: Whether to include metadata in XLSX exports - `exportDestination` 'email-burst': email-burst builds a filtered export for each control value and emails those files to the recipients. (Beta) **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. - `dynamicExportSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2DynamicExportSettings: Control IDs to split the export by. Required when exportDestination is set. Retrieve each control ID from the name field of the [GET /v2/workbooks/{workbookId}/controls](https://help.sigmacomputing.com/reference/get-workbook-controls) endpoint. (Beta) **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. - `variables` object: Map of list values control IDs to their value types. Use text or number for a single-select control, and text-list or number-list when multiple selection is on. For example, a multi-select text control named City-control is represented as { "City-control": { "type": "text-list" } }. - `dynamicRecipientSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2DynamicRecipientSettings: Sets the email recipients for each split-by control value in the burst. When set, each value's export goes to the emails in the specified table row instead of a shared recipient list. (Beta) **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. - `sourceNodeId` string, required: Element ID of the table that lists recipients for each burst value. Retrieve the elementId by calling the [GET /v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint. - `recipientColumnId` string, required: Column ID that contains recipient email addresses. Retrieve the columnId by calling the [GET /v2/workbooks/{workbookId}/elements/{elementId}/columns](https://help.sigmacomputing.com/reference/get-element-columns) endpoint. - `description` string, nullable: Description of the scheduled export - `suspensionAction` 'pause' | 'resume': Action to take on the schedule. Use `pause` to pause the schedule and `resume` to resume the schedule. ## Response `200` The response body. - WorkbooksUpdateWorkbookScheduleResponse200 - `scheduledNotificationId` string, required: Unique identifier of the scheduled export. - `workbookId` string, required: Unique identifier of the workbook. - `schedule` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaSchedule, required - `cronSpec` string, required: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - `timezone` string, required: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. - `configV2` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2, required - `title` string, required - `messageBody` string, required - `notificationAttachments` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems[], required - `formatOptions` union, required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0 - `type` 'CSV', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1 - `type` 'JSON', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2 - `type` 'JSONL', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3 - `type` 'EXCEL', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4 - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - `scaleFactor` number, double, nullable - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5 - `type` 'PNG', required - `pixelWidth` number, double, nullable - `pixelHeight` number, double, nullable - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6 - `type` 'NONE', required - `chartId` string - `workbookExportSource` union - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0: Export one element - `type` 'element', required - `elementId` string, required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1: Export one page - `type` 'page', required - `pageId` string, required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2: Export multiple elements - `type` 'element', required - `nodeIds` string[], required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3: Export multiple pages - `type` 'page', required - `nodeIds` string[], required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4: Export all pages and elements in a workbook - `type` 'all', required - `includeLink` boolean - `runAsRecipient` boolean - `attachmentSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings - `mergePdfAttachments` boolean - `zipAttachments` boolean - `conditionOptions` union - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0 - `type` 'always', required - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1 - `type` 'workbook', required - `conditions` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems[], required - union - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2 - `type` 'worksheet', required - `conditions` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems[], required - union - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3 - `type` 'dashboard', required - `conditions` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems[], required - union - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1 - … - V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2 - … - `alertConfig` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfig - `window` 'alltime' | 'daily' | 'weekly' | 'always', required - `volume` number, double, nullable - `notificationName` string - `dashboardSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettings - `filters` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems[], nullable - `id` string, required - `filterStr` string, required - `variableValues` union - DashVariables0 - `type` 'boolean', required - `value` boolean, nullable, required - DashVariables1 - `type` 'number', required - `value` number, double, nullable, required - DashVariables2 - `type` 'text', required - `value` string, nullable, required - DashVariables3 - `type` 'date', required - `value` union, required - DashVariablesOneOf3Value0 - … - DashVariablesOneOf3Value1 - … - DashVariables4 - `type` 'number-list', required - `value` number[], required - DashVariables5 - `type` 'text-list', required - `value` string[], required - DashVariables6 - `type` 'date-list', required - `value` number[], required - DashVariables7 - `type` 'boolean-list', required - `value` DashVariablesOneOf7Value, required - `true` boolean, required - `false` boolean, required - `null` boolean - DashVariables8 - `type` 'date-range', required - `min` union, required - DashVariablesOneOf8Min0 - … - DashVariablesOneOf8Min1 - … - `max` union, required - DashVariablesOneOf8Max0 - … - DashVariablesOneOf8Max1 - … - DashVariables9 - `type` 'number-range', required - `min` number, double, nullable, required - `max` number, double, nullable, required - DashVariables10 - `type` 'date-null', required - DashVariables11 - `type` 'number-null', required - DashVariables12 - `type` 'text-null', required - DashVariables13 - `type` 'boolean-null', required - DashVariables14 - `type` 'hierarchical-list', required - `value` string[], required - DashVariables15 - `type` 'file', required - `value` DashVariablesOneOf15Value, required - `id` string, required - `name` string, required - `size` number, double, required - `type` string, required - `downloadUrl` string, required - DashVariables16 - `type` 'file-null', required - DashVariables17 - `type` 'file-list', required - `value` DashVariablesOneOf17ValueItems[], required - `id` string, required - `name` string, required - `size` number, double, required - `type` string, required - `downloadUrl` string, required - `language` 'de' | 'en' | 'es' | 'fr' | 'it' | 'ja' | 'pl' | 'pt' | 'ru' | 'th' | 'en-au' | 'en-ca' | 'en-gb' | 'en-ie' | 'es-mx' | 'fr-ca' | 'ko-kr' | 'nl-nl' | 'pt-br' | 'sv-se' | 'tr-tr' | 'zh-cn' | 'zh-tw': The locale identifier corresponding to the language of the translation. - `languageVariant` string, nullable - `dynamicExportSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings - `variables` object - `dynamicRecipientSettings` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings - `sourceNodeId` string, required - `recipientColumnId` string, required - `rowLimit` number, double - `workbookVariant` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant - `tagId` string - `exploreKey` string - `bookmarkId` string - `embedOpts` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2EmbedOpts - `embedId` string - `evalConnectionId` string - `formatting` V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2Formatting - `pivotHeaderStyle` 'merged' | 'repeated' - `isSuspended` boolean, required: Whether the schedule is currently suspended. - `ownerId` string, required: Unique identifier of the user who owns the schedule. - `lastUpdatedByUser` string, required: Unique identifier of the user who last updated the schedule. - `disabledAt` string, date-time, nullable, required: Timestamp when the schedule was disabled, or null if the schedule is active. - `disabledBy` string, nullable, required: Unique identifier of the member who disabled the schedule, or null if the schedule is active. - `createdBy` string, required: The identifier of the user who created this object. - `updatedBy` string, required: The identifier of the user or process that last updated this object. - `createdAt` string, date-time, required: When the object was created. - `updatedAt` string, date-time, required: When the object was last updated. --- [API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)