Add Records To Clip

POST

https://api.x.flatfile.com/v1/data-clips/:dataClipId/add-records

POST

/v1/data-clips/:dataClipId/add-records

1 curl -X POST https://api.x.flatfile.com/v1/data-clips/dataClipId/add-records \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "recordIds": [
7     "recordIds",
8     "recordIds"
9   ]
10 }'

Try it

200Successful

1 {
2   "success": true,
3   "commitId": "commitId",
4   "counts": {
5     "total": 1,
6     "valid": 1,
7     "error": 1,
8     "byField": {
9       "byField": {
10         "total": 1,
11         "valid": 1,
12         "error": 1,
13         "empty": 1
14       }
15     },
16     "errorsByField": {
17       "errorsByField": 1
18     }
19   },
20   "records": [
21     {
22       "id": "id",
23       "values": {
24         "values": {
25           "layer": "layer",
26           "links": [
27             {
28               "id": "id",
29               "values": {
30                 "values": {}
31               }
32             },
33             {
34               "id": "id",
35               "values": {
36                 "values": {}
37               }
38             }
39           ],
40           "messages": [
41             {},
42             {}
43           ],
44           "updatedAt": "2024-01-15T09:30:00Z",
45           "valid": true,
46           "value": "value",
47           "metadata": {
48             "metadata": {
49               "key": "value"
50             }
51           }
52         }
53       },
54       "valid": true,
55       "messages": [
56         {
57           "field": "field",
58           "type": "error",
59           "source": "required-constraint",
60           "message": "message",
61           "path": "path"
62         },
63         {
64           "field": "field",
65           "type": "error",
66           "source": "required-constraint",
67           "message": "message",
68           "path": "path"
69         }
70       ],
71       "metadata": {
72         "metadata": {
73           "key": "value"
74         }
75       },
76       "config": {
77         "readonly": true,
78         "fields": {
79           "fields": {
80             "readonly": true
81           }
82         },
83         "markedForDeletion": true
84       }
85     },
86     {
87       "id": "id",
88       "values": {
89         "values": {
90           "layer": "layer",
91           "links": [
92             {
93               "id": "id",
94               "values": {
95                 "values": {}
96               }
97             },
98             {
99               "id": "id",
100               "values": {
101                 "values": {}
102               }
103             }
104           ],
105           "messages": [
106             {},
107             {}
108           ],
109           "updatedAt": "2024-01-15T09:30:00Z",
110           "valid": true,
111           "value": "value",
112           "metadata": {
113             "metadata": {
114               "key": "value"
115             }
116           }
117         }
118       },
119       "valid": true,
120       "messages": [
121         {
122           "field": "field",
123           "type": "error",
124           "source": "required-constraint",
125           "message": "message",
126           "path": "path"
127         },
128         {
129           "field": "field",
130           "type": "error",
131           "source": "required-constraint",
132           "message": "message",
133           "path": "path"
134         }
135       ],
136       "metadata": {
137         "metadata": {
138           "key": "value"
139         }
140       },
141       "config": {
142         "readonly": true,
143         "fields": {
144           "fields": {
145             "readonly": true
146           }
147         },
148         "markedForDeletion": true
149       }
150     }
151   ],
152   "versionId": "versionId"
153 }

Adds records to an existing DataClip.

Path parameters

dataClipIdstringRequired

Data Clip ID

Request

This endpoint expects an object.

recordIdslist of stringsRequired

Response

This endpoint returns an object.

successboolean

commitIdstring or null

Commit ID

countsobject or null

recordslist of objects or null

List of Record objects, including links to related rows

versionIdstring or nullDeprecated

Deprecated, use commitId instead.

Add Records To Clip

Path parameters

Headers

Request

Response

Errors