Insert records

POST

Adds records to a workbook sheet

Path parameters

sheetIdstringRequired

ID of sheet

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects a list of maps from strings to objects.

validbooleanOptional

messageslist of objectsOptional

valuestring or integer or long or double or boolean or date or datetime or list of stringsOptional

layerstringOptional

updatedAtdatetimeOptional

metadatamap from strings to anyOptionalDeprecated

Deprecated, use record level metadata instead.

Response

This endpoint returns an object.

dataobject

Errors

POST

1 curl -X POST 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     "firstName": {
8       "valid": true,
9       "messages": [],
10       "value": "John"
11     },
12     "lastName": {
13       "valid": true,
14       "messages": [],
15       "value": "Smith"
16     },
17     "email": {
18       "valid": true,
19       "messages": [],
20       "value": "john.smith@example.com"
21     }
22   }
23 ]'

200Example0

1 {
2   "data": {
3     "success": true,
4     "commitId": "us_vr_YOUR_ID",
5     "counts": {
6       "total": 1000,
7       "valid": 1000,
8       "error": 0
9     },
10     "records": [
11       {
12         "id": "us_rc_YOUR_ID",
13         "values": {
14           "firstName": {
15             "messages": [],
16             "updatedAt": "2023-11-20T16:59:40.286Z",
17             "valid": true,
18             "value": "John"
19           },
20           "lastName": {
21             "messages": [],
22             "updatedAt": "2023-11-20T16:59:40.286Z",
23             "valid": true,
24             "value": "Smith"
25           },
26           "email": {
27             "messages": [],
28             "updatedAt": "2023-11-20T16:59:40.286Z",
29             "valid": true,
30             "value": "john.smith@example.com"
31           }
32         },
33         "valid": true,
34         "metadata": {},
35         "config": {}
36       }
37     ],
38     "versionId": "us_vr_YOUR_ID"
39   }
40 }

Built with

1	curl -X POST 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	"firstName": {
8	"valid": true,
9	"messages": [],
10	"value": "John"
11	},
12	"lastName": {
13	"valid": true,
14	"messages": [],
15	"value": "Smith"
16	},
17	"email": {
18	"valid": true,
19	"messages": [],
20	"value": "john.smith@example.com"
21	}
22	}
23	]'

1	{
2	"data": {
3	"success": true,
4	"commitId": "us_vr_YOUR_ID",
5	"counts": {
6	"total": 1000,
7	"valid": 1000,
8	"error": 0
9	},
10	"records": [
11	{
12	"id": "us_rc_YOUR_ID",
13	"values": {
14	"firstName": {
15	"messages": [],
16	"updatedAt": "2023-11-20T16:59:40.286Z",
17	"valid": true,
18	"value": "John"
19	},
20	"lastName": {
21	"messages": [],
22	"updatedAt": "2023-11-20T16:59:40.286Z",
23	"valid": true,
24	"value": "Smith"
25	},
26	"email": {
27	"messages": [],
28	"updatedAt": "2023-11-20T16:59:40.286Z",
29	"valid": true,
30	"value": "john.smith@example.com"
31	}
32	},
33	"valid": true,
34	"metadata": {},
35	"config": {}
36	}
37	],
38	"versionId": "us_vr_YOUR_ID"
39	}
40	}