Sheets

Update a sheet

PATCH
Updates Sheet

Path parameters

sheetIdstringRequired
ID of sheet

Request

This endpoint expects an object.
name
stringOptional
The name of the Sheet.
slug
stringOptional
The slug of the Sheet.
metadata
anyOptional
Useful for any contextual metadata regarding the sheet. Store any valid json

Response

This endpoint returns an object
data
object
A place to store tabular data

Errors

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