Create a workbook

View as MarkdownOpen in Claude
This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up. ### Usage notes - The `name` parameter is required to provide a name for the new workbook. - Use the **folderId** to specify the folder in which to save the workbook. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Project initialization**: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses. - **Template preparation**: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting. ### Best practices - **Naming conventions**: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects. - **Folder organization**: Use the **folderId** to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams. - **Access control**: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
folderIdstringRequired
ID of the folder where the new workbook is created.
namestringRequired
Name of the new workbook.
descriptionstringOptional
Description of the workbook.
ownerIdstringOptional

ID of the user (member) to own the workbook.

Response

The response body.
workbookIdstring
Unique identifier of the workbook.
workbookUrlIdstring
namestring
urlstring
pathstring
latestVersiondouble
ownerIdstring
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
isArchivedboolean
tagslist of objects
descriptionstring