Update a sheet

PATCH

Updates Sheet

Path parameters

sheetIdstringRequired

ID of sheet

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

namestringOptional

The name of the Sheet.

slugstringOptional

The slug of the Sheet.

metadataanyOptional

Useful for any contextual metadata regarding the sheet. Store any valid json

Response

This endpoint returns an object.

dataobject

A place to store tabular data

Errors

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "name": "New Sheet Name",
7   "metadata": {
8     "rowHeaders": [
9       6
10     ]
11   }
12 }'

200Example0

1 {
2   "data": {
3     "id": "us_sh_YOUR_ID",
4     "workbookId": "us_wb_YOUR_ID",
5     "name": "New Sheet Name",
6     "slug": "contacts",
7     "config": {
8       "name": "Contacts",
9       "fields": [
10         {
11           "type": "string",
12           "key": "firstName",
13           "label": "First Name"
14         },
15         {
16           "type": "string",
17           "key": "lastName",
18           "label": "Last Name"
19         },
20         {
21           "type": "string",
22           "key": "email",
23           "label": "Email"
24         }
25       ],
26       "slug": "contacts",
27       "mappingConfidenceThreshold": 0.5
28     },
29     "updatedAt": "2021-08-31T18:00:00Z",
30     "createdAt": "2021-08-31T18:00:00Z",
31     "metadata": {
32       "rowHeaders": [
33         6
34       ]
35     }
36   }
37 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"name": "New Sheet Name",
7	"metadata": {
8	"rowHeaders": [
9	6
10	]
11	}
12	}'

1	{
2	"data": {
3	"id": "us_sh_YOUR_ID",
4	"workbookId": "us_wb_YOUR_ID",
5	"name": "New Sheet Name",
6	"slug": "contacts",
7	"config": {
8	"name": "Contacts",
9	"fields": [
10	{
11	"type": "string",
12	"key": "firstName",
13	"label": "First Name"
14	},
15	{
16	"type": "string",
17	"key": "lastName",
18	"label": "Last Name"
19	},
20	{
21	"type": "string",
22	"key": "email",
23	"label": "Email"
24	}
25	],
26	"slug": "contacts",
27	"mappingConfidenceThreshold": 0.5
28	},
29	"updatedAt": "2021-08-31T18:00:00Z",
30	"createdAt": "2021-08-31T18:00:00Z",
31	"metadata": {
32	"rowHeaders": [
33	6
34	]
35	}
36	}
37	}