Skip to navigation
Sigma REST APIWorkbooks{workbookId}

Share a workbook with another organization

View as Markdown

Share a workbook or a template with another organization. Optionally share the associated datasets, if datasets (deprecated) are used as the source.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • Retrieve the templateId by calling the v2/templates endpoint.
  • Retrieve the organization slug from the URL. Ask the recipient organization for the segment of their Sigma URL following app.sigmacomputing.com. For example, app.sigmacomputing.com/sigma-docs has an organization slug of sigma-docs.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
The unique identifier of the workbook or template. This ID is used to fetch, update, or delete specific workbook resources.

Request

The request body.
orgSlugslist of stringsRequired
The unique identifiers of the organizations to share the workbook with.
shareDatasetsbooleanOptional

Whether to share the datasets (deprecated) associated with the workbook.

copyInputTableDatabooleanOptional
Whether to copy input table data to the recipient organization.
sendEmailbooleanOptional
Whether to send an email to admins in the recipient org.
emailMessagestringOptional
The message to send to the recipients, if sendEmail is true.

Response

The response body.