Create a workbook — Flatfile

Creates a workbook and adds it to a space

Headers

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 "EXTRACTED_FROM_SOURCE" or "SMALL_DATA"Optional

Allowed values: EXTRACTED_FROM_SOURCESMALL_DATA

Treatments for the workbook

Response

This endpoint returns an object.

dataobject

A collection of one or more sheets

Errors

1 curl -X POST https://api.x.flatfile.com/v1/workbooks \ 2 -H "X-Disable-Hooks: true" \ 3 -H "Authorization: Bearer <token>" \ 4 -H "Content-Type: application/json" \ 5 -d '{ 6 "name": "My First Workbook", 7 "labels": [ 8 "simple-demo" 9 ], 10 "sheets": [ 11 { 12 "name": "Contacts", 13 "fields": [ 14 { 15 "type": "string", 16 "key": "firstName", 17 "label": "First Name" 18 }, 19 { 20 "type": "string", 21 "key": "lastName", 22 "label": "Last Name" 23 }, 24 { 25 "type": "string", 26 "key": "email", 27 "label": "Email" 28 } 29 ], 30 "slug": "contacts", 31 "mappingConfidenceThreshold": 0.5 32 } 33 ], 34 "actions": [ 35 { 36 "label": "Submit", 37 "description": "Submit data to webhook.site", 38 "mode": "foreground", 39 "operation": "submitAction", 40 "primary": true 41 } 42 ], 43 "settings": { 44 "trackChanges": 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 }

1	curl -X POST https://api.x.flatfile.com/v1/workbooks \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "My First Workbook",
7	"labels": [
8	"simple-demo"
9	],
10	"sheets": [
11	{
12	"name": "Contacts",
13	"fields": [
14	{
15	"type": "string",
16	"key": "firstName",
17	"label": "First Name"
18	},
19	{
20	"type": "string",
21	"key": "lastName",
22	"label": "Last Name"
23	},
24	{
25	"type": "string",
26	"key": "email",
27	"label": "Email"
28	}
29	],
30	"slug": "contacts",
31	"mappingConfidenceThreshold": 0.5
32	}
33	],
34	"actions": [
35	{
36	"label": "Submit",
37	"description": "Submit data to webhook.site",
38	"mode": "foreground",
39	"operation": "submitAction",
40	"primary": true
41	}
42	],
43	"settings": {
44	"trackChanges": 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	}