Update a workbook — Flatfile

Updates a workbook

Path parameters

workbookIdstringRequired

ID of workbook to update

Request

This endpoint expects an object.

namestringOptional

The name of the Workbook.

labelslist of stringsOptional

An optional list of labels for the Workbook.

spaceIdstringOptional

The Space Id associated with the Workbook.

environmentIdstringOptional

The Environment Id associated with the Workbook.

namespacestringOptional

The namespace of the Workbook.

sheetslist of objectsOptional

Describes shape of data as well as behavior

actionslist of objectsOptional

metadataanyOptional

Metadata for the workbook

Response

This endpoint returns an object.

dataobject

A collection of one or more sheets

Errors

1 curl -X PATCH https://api.x.flatfile.com/v1/workbooks/us_wb_YOUR_ID \ 2 -H "X-Disable-Hooks: true" \ 3 -H "Authorization: Bearer <token>" \ 4 -H "Content-Type: application/json" \ 5 -d '{ 6 "name": "My Updated Workbook", 7 "labels": [ 8 "my-new-label" 9 ], 10 "actions": [ 11 { 12 "operation": "submitAction", 13 "mode": "foreground", 14 "label": "Submit Changes", 15 "description": "Submit data to webhook.site", 16 "primary": true 17 } 18 ] 19 }'

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

1	curl -X PATCH https://api.x.flatfile.com/v1/workbooks/us_wb_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "My Updated Workbook",
7	"labels": [
8	"my-new-label"
9	],
10	"actions": [
11	{
12	"operation": "submitAction",
13	"mode": "foreground",
14	"label": "Submit Changes",
15	"description": "Submit data to webhook.site",
16	"primary": true
17	}
18	]
19	}'

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