Create a workbook | Flatfile

1 from flatfile import Flatfile 2 from flatfile.commons import Action 3 from flatfile.property import Property_String 4 from flatfile.sheets import SheetConfig 5 from flatfile.workbooks import WorkbookConfigSettings 6 7 client = Flatfile( 8 token="YOUR_TOKEN", 9 ) 10 client.workbooks.create( 11 name="My First Workbook", 12 sheets=[ 13 SheetConfig( 14 name="Contacts", 15 slug="contacts", 16 fields=[ 17 Property_String( 18 key="firstName", 19 label="First Name", 20 ), 21 Property_String( 22 key="lastName", 23 label="Last Name", 24 ), 25 Property_String( 26 key="email", 27 label="Email", 28 ), 29 ], 30 mapping_confidence_threshold=0.5, 31 ) 32 ], 33 labels=["simple-demo"], 34 actions=[ 35 Action( 36 operation="submitAction", 37 mode="foreground", 38 label="Submit", 39 description="Submit data to webhook.site", 40 primary=True, 41 ) 42 ], 43 settings=WorkbookConfigSettings( 44 track_changes=True, 45 ), 46 )

1 { 2 "data": { 3 "id": "us_wb_YOUR_ID", 4 "spaceId": "us_sp_YOUR_ID", 5 "environmentId": "us_env_YOUR_ID", 6 "updatedAt": "2021-01-01T00:00:00Z", 7 "createdAt": "2021-01-01T00:00:00Z", 8 "name": "My First Workbook", 9 "sheets": [ 10 { 11 "id": "us_sh_YOUR_ID", 12 "workbookId": "us_wb_YOUR_ID", 13 "name": "Contacts", 14 "slug": "contacts", 15 "config": { 16 "name": "Contacts", 17 "fields": [ 18 { 19 "type": "string", 20 "key": "firstName", 21 "label": "First Name" 22 }, 23 { 24 "type": "string", 25 "key": "lastName", 26 "label": "Last Name" 27 }, 28 { 29 "type": "string", 30 "key": "email", 31 "label": "Email" 32 } 33 ], 34 "slug": "contacts", 35 "mappingConfidenceThreshold": 0.5 36 }, 37 "updatedAt": "2021-08-31T18:00:00Z", 38 "createdAt": "2021-08-31T18:00:00Z", 39 "metadata": { 40 "rowHeaders": [ 41 4 42 ] 43 } 44 } 45 ], 46 "labels": [ 47 "simple-demo" 48 ], 49 "actions": [ 50 { 51 "label": "Submit", 52 "description": "Submit data to webhook.site", 53 "mode": "foreground", 54 "operation": "submitAction", 55 "primary": true 56 } 57 ], 58 "settings": { 59 "trackChanges": true 60 }, 61 "expiredAt": "2021-01-01T00:00:00Z" 62 } 63 }

Creates a workbook and adds it to a space

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

Headers

Request

Response

Errors