Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
Guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
GET
List workbooks
POST
Create a workbook
GET
Get a workbook
DEL
Delete a workbook
PATCH
Update a workbook
GET
Get commits for a workbook
Community
Create Account
Sign in
API Reference
Workbooks
Update a workbook
PATCH
https://api.x.flatfile.com/v1
/
workbooks
/
:workbookId
Updates a workbook
Path parameters
workbookId
string
Required
ID of workbook to update
Request
This endpoint expects an object.
name
string
Optional
The name of the Workbook.
labels
list of strings
Optional
An optional list of labels for the Workbook.
spaceId
string
Optional
The Space Id associated with the Workbook.
environmentId
string
Optional
The Environment Id associated with the Workbook.
namespace
string
Optional
The namespace of the Workbook.
sheets
list of objects
Optional
Describes shape of data as well as behavior
Show 16 properties
actions
list of objects
Optional
Show 19 properties
metadata
any
Optional
Metadata for the workbook
Response
This endpoint returns an object.
data
object
A collection of one or more sheets
Show 14 properties
Errors
400
Bad Request
404
Not Found
Built with