Export a workbook

POST

/v2/workbooks/:workbookId/send

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 endpoint.
This endpoint is rate limited to 100 requests per minute.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Request

The request body.

targetslist of objectsRequired

configobjectRequired

attachmentslist of objectsRequired

parametersmap from strings to stringsOptional

timeoutdoubleOptional

conditionslist of objectsOptional

sendAsUserstringOptional

Response

The response body.

$	curl -X POST https://api.sigmacomputing.com/v2/workbooks/workbookId/send \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"targets": [
>	{
>	"email": "test@example.com",
>	"type": "email"
>	}
>	],
>	"config": {
>	"title": "My report",
>	"messageBody": "My report body",
>	"includeLink": true,
>	"runAsRecipient": true
>	},
>	"attachments": [
>	{
>	"formatOptions": {
>	"type": "PDF"
>	},
>	"source": {
>	"type": "all"
>	}
>	}
>	]
>	}'