Records

Update records

PUT
Updates existing records in a workbook sheet

Path parameters

sheetIdstringRequired
ID of sheet

Request

This endpoint expects a list of objects.
id
stringRequired
Record ID
values
map from strings to objectsRequired
A single row of data in a Sheet
commitId
stringOptional
Commit ID
config
objectOptional
Configuration of a record or specific fields in the record
metadata
map from strings to anyOptional
valid
booleanOptional
Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
messages
list of objectsOptionalDeprecated

This record level messages property is deprecated and no longer stored or used. Use the messages property on the individual cell values instead. This property will be removed in a future release.

versionId
stringOptionalDeprecated

Deprecated, use commitId instead.

Response

This endpoint returns an object
data
object

Errors

PUT
$curl -X PUT https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/records \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "id": "us_rc_YOUR_ID",
>    "values": {
>      "firstName": {
>        "valid": true,
>        "messages": [],
>        "value": "John"
>      },
>      "lastName": {
>        "valid": true,
>        "messages": [],
>        "value": "Smith"
>      },
>      "email": {
>        "valid": true,
>        "messages": [],
>        "value": "john.smith@example.com"
>      }
>    },
>    "commitId": "us_vr_YOUR_ID",
>    "config": {},
>    "metadata": {},
>    "valid": true,
>    "versionId": "us_vr_YOUR_ID"
>  }
>]'
Response
1{
2  "data": {
3    "versionId": "us_vr_YOUR_ID"
4  }
5}
Built with