API ReferenceWorkbooks

Create a workbook

Creates a workbook and adds it to a space

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.
namestringRequired
The name of the Workbook.
labelslist of stringsOptional
An optional list of labels for the Workbook.
spaceIdstringOptional
Space to associate with the Workbook.
environmentIdstringOptional
Environment to associate with the Workbook
namespacestringOptional
Optional namespace to apply to the Workbook.
sheetslist of objectsOptional
Sheets to create on the Workbook.
actionslist of objectsOptional
Actions to create on the Workbook.
settingsobjectOptional
The Workbook settings.
metadataanyOptional
Metadata for the workbook
treatmentslist of enumsOptional
Treatments for the workbook
Allowed values:

Response

This endpoint returns an object.
dataobject
A collection of one or more sheets

Errors