---
title: "Add workbook schedule"
method: POST
path: "/v2/workbooks/{workbookId}/schedules"
tags: ["Workbooks"]
---

# Add workbook schedule

`POST /v2/workbooks/{workbookId}/schedules`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/schedules`
- Auth: HTTP bearer

Add a schedule to 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 relevant IDs based on the export contents and destination:

    - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.
    - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.
  - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.
  - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.
  - Email burst is not available for trial organizations.
  - To schedule an email burst, set `configV2.exportDestination` to `email-burst` and list split-by controls in `configV2.dynamicExportSettings.variables`. Provide recipients in `target`, or set `dynamicRecipientSettings` to resolve recipients per control value.

## Path parameters

- `workbookId` string, required

## Request body

- object
  - `target` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaTargetItems[], required: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule, required: When to send the workbook export.
    - `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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2: Configuration settings for the export schedule.
    - `title` string, required: Title of the message
    - `messageBody` string, required: Body of the message
    - `exportAttachments` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems[], required: Attachments to include in the export
      - `formatOptions` union, required: Export format options
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0: CSV export format options
          - `type` 'CSV', required
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1: JSONL export format options
          - `type` 'JSONL', required
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2: JSON export format options
          - `type` 'JSON', required
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3: XLSX export format options
          - `type` 'XLSX', required
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4: PDF export format options
          - `type` 'PDF', required
          - `layout` 'portrait' | 'landscape'
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5: PNG export format options
          - `type` 'PNG', required
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6: No export format options
          - `type` 'NONE', required
      - `workbookExportSource` union, required: Workbook export source options
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0: Export multiple elements
          - `type` 'element', required
          - `elementIds` string[], required: Array of element identifiers to export
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1: Export multiple pages
          - `type` 'page', required
          - `pageIds` string[], required: Array of page identifiers to export
        - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings: Export attachment settings
      - `mergeAttachments` boolean: Combines multiple PDF or XLSX attachments into a single file
      - `zipAttachments` boolean: Send attachments as a .zip file
    - `workbookVariant` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant: Workbook variant
      - `tagId` string: Version tag to export
      - `bookmarkId` string: Saved view (formerly called a bookmark) to export
    - `conditionOptions` union: Export condition options
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0: Always send the export
        - `type` 'always', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1: Send the export based on a condition
        - `type` 'workbook', required
        - `condition` union, required
          - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0: If there's no data
            - `type` 'isEmpty', required: Type of condition
            - `elementId` string, required: ID of the element
          - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1: If there's data
            - `type` 'isNotEmpty', required: Type of condition
            - `elementId` string, required: ID of the element
          - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2Formatting: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2DynamicExportSettings: 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` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2DynamicRecipientSettings: 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.
  - `config` V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfig: **[Deprecated]** Configuration settings for the export.
    - `formatOptions` union, required: Export format options
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions0: CSV export format options
        - `type` 'CSV', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions1: JSONL export format options
        - `type` 'JSONL', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions2: JSON export format options
        - `type` 'JSON', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions3: XLSX export format options
        - `type` 'XLSX', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions4: PDF export format options
        - `type` 'PDF', required
        - `layout` 'portrait' | 'landscape'
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions5: PNG export format options
        - `type` 'PNG', required
      - V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions6: No export format options
        - `type` 'NONE', required
    - `title` string, required: Title of the message
    - `messageBody` string, required: Body of the message
    - `includeLink` boolean: Whether to include a link to the exported folder or document in the body of the message
    - `runAsRecipient` boolean: Whether to run the export as if it were being run by the recipient
    - `rowLimit` number, double: Maximum number of rows to export
    - `chartId` string: Identifier of the chart to export
    - `parameters` object: Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value. **Syntax** { control-id: control-value } The control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control. Values can take multiple forms, depending on the data type of the control: **Boolean** - Single value: "true" | "false" | ":null" - List of Boolean: "true,false,:null" (No space after the comma.) **Number** - Single value: "10.54", ":null" - List of values: "10.54,23.45,:null" (No space after the comma.) - Range of numbers: "min:10.54,max:23.45" (No space after the comma or colon.) **Text** - Single value: "some-text" | ":null" | ":empty" - List of values: "some-text,more-text,:null,:empty" (No space after the comma.) **Date** All dates use UTC time zones. - Fixed date using ISO-6801 format: "2022-01-01T01:01:59" | ":null" - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds): - %Y-%m-%d - %Y-%m-%dT%H:%M - %Y-%m-%dT%H:%M:%S - List of fixed dates: "2022-01-01T01:01:59,2022-02-02T02:02:59,:null" - Relative date: "prior-day-3" | "next-day-3" - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number] - Date range: "min:2022-01-01T01:01:59,max:next-day-3" (No spaces after the comma or colon.) - Leave max blank for "on or after" and min blank for "on or before", for example: - "Date-Range": "min:2020-04-01,max:" - "Date-Range": "min:,max:next-day-3" **Notes** - ":null" is a special value that denotes the null primitive value. - ":empty" is a special value that denotes the empty string "". Use [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators. For example: "New York, NY,Boston, MA" can be encoded as: "New%20York%2C%20NY,Boston%2C%20MA"
  - `description` string, nullable: Description of the scheduled export
  - `ownerId` string: ID of the user (member) to own the export.

## Response `200`

The response body.

- WorkbooksPostWorkbookScheduleResponse200
  - `scheduledNotificationId` string, required: Unique identifier of the scheduled export.
  - `workbookId` string, required: Unique identifier of the workbook.
  - `schedule` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaSchedule, 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` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2, required
    - `title` string, required
    - `messageBody` string, required
    - `notificationAttachments` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems[], required
      - `formatOptions` union, required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0
          - `type` 'CSV', required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1
          - `type` 'JSON', required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2
          - `type` 'JSONL', required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3
          - `type` 'EXCEL', required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4
          - `type` 'PDF', required
          - `layout` 'portrait' | 'landscape'
          - `scaleFactor` number, double, nullable
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5
          - `type` 'PNG', required
          - `pixelWidth` number, double, nullable
          - `pixelHeight` number, double, nullable
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6
          - `type` 'NONE', required
      - `chartId` string
      - `workbookExportSource` union
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0: Export one element
          - `type` 'element', required
          - `elementId` string, required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1: Export one page
          - `type` 'page', required
          - `pageId` string, required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2: Export multiple elements
          - `type` 'element', required
          - `nodeIds` string[], required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3: Export multiple pages
          - `type` 'page', required
          - `nodeIds` string[], required
        - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4: Export all pages and elements in a workbook
          - `type` 'all', required
    - `includeLink` boolean
    - `runAsRecipient` boolean
    - `attachmentSettings` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings
      - `mergePdfAttachments` boolean
      - `zipAttachments` boolean
    - `conditionOptions` union
      - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0
        - `type` 'always', required
      - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1
        - `type` 'workbook', required
        - `conditions` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems[], required
          - union
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2
              - …
      - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2
        - `type` 'worksheet', required
        - `conditions` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems[], required
          - union
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2
              - …
      - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3
        - `type` 'dashboard', required
        - `conditions` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems[], required
          - union
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1
              - …
            - V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2
              - …
    - `alertConfig` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfig
      - `window` 'alltime' | 'daily' | 'weekly' | 'always', required
      - `volume` number, double, nullable
    - `notificationName` string
    - `dashboardSettings` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettings
      - `filters` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems[], 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` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings
      - `variables` object
    - `dynamicRecipientSettings` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings
      - `sourceNodeId` string, required
      - `recipientColumnId` string, required
    - `rowLimit` number, double
    - `workbookVariant` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant
      - `tagId` string
      - `exploreKey` string
      - `bookmarkId` string
    - `embedOpts` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2EmbedOpts
      - `embedId` string
      - `evalConnectionId` string
    - `formatting` V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2Formatting
      - `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)
