--- title: "Export a workbook" method: POST path: "/v2/workbooks/{workbookId}/send" tags: ["Workbooks"] --- # Export a workbook `POST /v2/workbooks/{workbookId}/send` ## Request - Base URL: `https://api.sigmacomputing.com` - URL: `https://api.sigmacomputing.com/v2/workbooks/{workbookId}/send` - Auth: HTTP bearer Export a workbook to one or more destinations, such as an email address, a Slack channel, or cloud storage. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - This endpoint is rate limited to 100 requests per minute. - Email and download bursts are limited to 5 requests per minute. - Email burst and download burst are not available for trial organizations. - To send an email burst, set `configV2.exportDestination` to `email-burst` and list the controls to split by in `configV2.dynamicExportSettings.variables`. Provide recipients in `target`, or set `dynamicRecipientSettings` to resolve recipients per control value. - To send a download burst, set `configV2.exportDestination` to `burst-download` and list the controls to split by in `configV2.dynamicExportSettings.variables`. Do not include recipients, Sigma emails a download link for the split files to the user making the request. ## Path parameters - `workbookId` string, required ## Request body - union - WorkbooksSendWorkbookRequest0: Export using `target` and `configV2`. - `parameters` object - `timeout` number, double - `conditions` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConditionsItems[] - union: Send based on conditions - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConditionsItems0 - `type` 'isEmpty', required - `elementId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConditionsItems1 - `type` 'isNotEmpty', required - `elementId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConditionsItems2 - `type` 'sheetColumn', required - `elementId` string, required - `columnId` string, required - `op` 'Equals' | 'GreaterThan' | 'GreaterThanEq' | 'LessThan' | 'LessThanEq' | 'NotEquals' | 'IsNull' | 'IsNotNull' | 'Contains' | 'StartsWith' | 'EndsWith', required: Operator - `mode` 'any' | 'all', required: Check condition - `value` union: Set a constant value for condition - DataTypes0 - … - DataTypes1 - … - DataTypes2 - … - DataTypes3 - … - DataTypes4 - … - DataTypes5 - … - DataTypes6 - … - DataTypes7 - … - DataTypes8 - … - DataTypes9 - … - `sendAsUser` string - `target` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0TargetItems[], required - `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 - `configV2` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2, required - `title` string, required: Title of the message - `messageBody` string, required: Body of the message - `exportAttachments` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItems[], required: Attachments to include in the export - `formatOptions` union, required: Export format options - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions0: CSV export format options - `type` 'CSV', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions1: JSONL export format options - `type` 'JSONL', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions2: JSON export format options - `type` 'JSON', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions3: XLSX export format options - `type` 'XLSX', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions4: PDF export format options - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions5: PNG export format options - `type` 'PNG', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsFormatOptions6: No export format options - `type` 'NONE', required - `workbookExportSource` union, required: Workbook export source options - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsWorkbookExportSource0: Export multiple elements - `type` 'element', required - `elementIds` string[], required: Array of element identifiers to export - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsWorkbookExportSource1: Export multiple pages - `type` 'page', required - `pageIds` string[], required: Array of page identifiers to export - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ExportAttachmentsItemsWorkbookExportSource2: 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` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2AttachmentSettings: Export attachment settings - `mergeAttachments` boolean: Combines multiple PDF or XLSX attachments into a single file - `zipAttachments` boolean: Send attachments as a .zip file - `workbookVariant` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2WorkbookVariant: Workbook variant - `tagId` string: Version tag to export - `bookmarkId` string: Saved view (formerly called a bookmark) to export - `conditionOptions` union: Export condition options - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ConditionOptions0: Always send the export - `type` 'always', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ConditionOptions1: Send the export based on a condition - `type` 'workbook', required - `condition` union, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ConditionOptionsOneOf1Condition0: If there's no data - … - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ConditionOptionsOneOf1Condition1: If there's data - … - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2ConditionOptionsOneOf1Condition2: If a condition is met - … - `workbookSettings` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2WorkbookSettings: 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` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2Formatting: Export formatting options - `pivotHeaderStyle` 'merged' | 'repeated': Style of pivot table headers - `includeMetadata` boolean: Whether to include metadata in XLSX exports - `exportDestination` 'email-burst' | 'burst-download': email-burst builds a filtered export for each control value and emails those files to the recipients. burst-download puts those files in a zip and emails a download link. (Beta) **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. - `dynamicExportSettings` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2DynamicExportSettings: 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` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf0ConfigV2DynamicRecipientSettings: 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. - WorkbooksSendWorkbookRequest1: **[Deprecated]** Use `target` and `configV2` instead of `targets`, `config`, and `attachments`. - `parameters` object - `timeout` number, double - `conditions` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1ConditionsItems[] - union: Send based on conditions - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1ConditionsItems0 - `type` 'isEmpty', required - `elementId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1ConditionsItems1 - `type` 'isNotEmpty', required - `elementId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1ConditionsItems2 - `type` 'sheetColumn', required - `elementId` string, required - `columnId` string, required - `op` 'Equals' | 'GreaterThan' | 'GreaterThanEq' | 'LessThan' | 'LessThanEq' | 'NotEquals' | 'IsNull' | 'IsNotNull' | 'Contains' | 'StartsWith' | 'EndsWith', required: Operator - `mode` 'any' | 'all', required: Check condition - `value` union: Set a constant value for condition - DataTypes0 - … - DataTypes1 - … - DataTypes2 - … - DataTypes3 - … - DataTypes4 - … - DataTypes5 - … - DataTypes6 - … - DataTypes7 - … - DataTypes8 - … - DataTypes9 - … - `sendAsUser` string - `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. - `targets` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems[], required: **[Deprecated]** Use `target` with `configV2`. - union - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems0 - `type` 'member', required - `userId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems1 - `type` 'team', required - `teamId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems2 - `type` 'email', required - `email` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems3 - `type` 'slackChannel', required - `slackConversationId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems4 - `type` 'gsheet', required - `googleSpreadsheetUrl` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems5 - `type` 'gdrive', required - `googleDriveFolderUrl` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems6 - `type` 'webhook', required - `webhookUrl` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItems7 - `type` 'workbook-cloud-export', required - `workbookCloudExport` union, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItemsOneOf7WorkbookCloudExport0 - … - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1TargetsItemsOneOf7WorkbookCloudExport1 - … - `config` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1Config, required: **[Deprecated]** Use `configV2`. - `title` string, required - `messageBody` string, required - `includeLink` boolean - `runAsRecipient` boolean - `rowLimit` number, double - `attachments` V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItems[], required: **[Deprecated]** Set attachments on `configV2.exportAttachments`. - `formatOptions` union, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions0 - `type` 'CSV', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions1 - `type` 'JSON', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions2 - `type` 'JSONL', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions3 - `type` 'EXCEL', required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions4 - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - `scaleFactor` number, double, nullable - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions5 - `type` 'PNG', required - `pixelWidth` number, double, nullable - `pixelHeight` number, double, nullable - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsFormatOptions6 - `type` 'NONE', required - `source` union, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsSource0: Export one element - `type` 'element', required - `elementId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsSource1: Export one page - `type` 'page', required - `pageId` string, required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsSource2: Export multiple elements - `type` 'element', required - `nodeIds` string[], required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsSource3: Export multiple pages - `type` 'page', required - `nodeIds` string[], required - V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaOneOf1AttachmentsItemsSource4: Export all pages and elements in a workbook - `type` 'all', required ## Response `200` The response body. - WorkbooksSendWorkbookResponse200 --- [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)