Skip to navigation
Sigma REST APIWorkbooks{workbookId}

Save a template from a workbook

View as Markdown

Create a workbook template from an existing workbook.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • The template owner defaults to the user associated with the API credentials. You can specify an owner in the request body with the ownerId. Retrieve the user ID to use as the ownerID by calling the /v2/members endpoint and using the memberId included in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Request

The request body.
namestringOptional
Name of the template to create.
ownerIdstringOptional
tagstringOptional

Response

The response body.
templateIdstring