Update records

PUT

Updates existing records in a workbook sheet

Path parameters

sheetIdstringRequired

ID of sheet

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects a list of objects.

list of objects

Response

This endpoint returns an object.

dataobject

Errors

PUT

1 curl -X PUT https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/records \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '[
6   {
7     "id": "us_rc_YOUR_ID",
8     "values": {
9       "firstName": {
10         "valid": true,
11         "messages": [],
12         "value": "John"
13       },
14       "lastName": {
15         "valid": true,
16         "messages": [],
17         "value": "Smith"
18       },
19       "email": {
20         "valid": true,
21         "messages": [],
22         "value": "john.smith@example.com"
23       }
24     },
25     "commitId": "us_vr_YOUR_ID",
26     "config": {},
27     "metadata": {},
28     "valid": true,
29     "versionId": "us_vr_YOUR_ID"
30   }
31 ]'

200Example0

1 {
2   "data": {
3     "versionId": "us_vr_YOUR_ID"
4   }
5 }

Built with

1	curl -X PUT https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/records \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '[
6	{
7	"id": "us_rc_YOUR_ID",
8	"values": {
9	"firstName": {
10	"valid": true,
11	"messages": [],
12	"value": "John"
13	},
14	"lastName": {
15	"valid": true,
16	"messages": [],
17	"value": "Smith"
18	},
19	"email": {
20	"valid": true,
21	"messages": [],
22	"value": "john.smith@example.com"
23	}
24	},
25	"commitId": "us_vr_YOUR_ID",
26	"config": {},
27	"metadata": {},
28	"valid": true,
29	"versionId": "us_vr_YOUR_ID"
30	}
31	]'