Workbooks

Share a workbook with another organization

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.
post/v2/workbooks/{workbookId}/shareCrossOrg

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

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

Request body

orgSlugsstring[] required

The unique identifiers of the organizations to share the workbook with.

shareDatasetsboolean

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

copyInputTableDataboolean

Whether to copy input table data to the recipient organization.

sendEmailboolean

Whether to send an email to admins in the recipient org.

emailMessagestring

The message to send to the recipients, if sendEmail is true.

Response

The response body.

WorkbooksShareWorkbookCrossOrgResponse200 required

Changes

No recorded changes to this operation across all 1 revision of this API.