Update a sheet | Flatfile

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

{
  "data": {
    "id": "us_sh_YOUR_ID",
    "workbookId": "us_wb_YOUR_ID",
    "name": "New Sheet Name",
    "slug": "contacts",
    "config": {
      "name": "Contacts",
      "fields": [
        {
          "type": "string",
          "key": "firstName",
          "label": "First Name"
        },
        {
          "type": "string",
          "key": "lastName",
          "label": "Last Name"
        },
        {
          "type": "string",
          "key": "email",
          "label": "Email"
        }
      ],
      "slug": "contacts",
      "mappingConfidenceThreshold": 0.5
    },
    "updatedAt": "2021-08-31T18:00:00Z",
    "createdAt": "2021-08-31T18:00:00Z",
    "metadata": {
      "rowHeaders": [
        6
      ]
    }
  }
}

Updates Sheet

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sheetIdstringRequired

ID of sheet

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

400

Bad Request Error

404

Not Found Error

$	curl -X PATCH https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID \
>	-H "X-Disable-Hooks: true" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "New Sheet Name",
>	"metadata": {
>	"rowHeaders": [
>	6
>	]
>	}
>	}'

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	}