Insert records | Flatfile

from flatfile import Flatfile
from flatfile.records import CellValue
client = Flatfile(
    token="YOUR_TOKEN",
)
client.records.insert(
    sheet_id="us_sh_YOUR_ID",
    request=[
        {
            "firstName": CellValue(
                value="John",
                messages=[],
                valid=True,
            ),
            "lastName": CellValue(
                value="Smith",
                messages=[],
                valid=True,
            ),
            "email": CellValue(
                value="john.smith@example.com",
                messages=[],
                valid=True,
            ),
        }
    ],
)

{
  "data": {
    "success": true,
    "commitId": "us_vr_YOUR_ID",
    "counts": {
      "total": 1000,
      "valid": 1000,
      "error": 0
    },
    "records": [
      {
        "id": "us_rc_YOUR_ID",
        "values": {
          "firstName": {
            "messages": [],
            "updatedAt": "2023-11-20T16:59:40.286Z",
            "valid": true,
            "value": "John"
          },
          "lastName": {
            "messages": [],
            "updatedAt": "2023-11-20T16:59:40.286Z",
            "valid": true,
            "value": "Smith"
          },
          "email": {
            "messages": [],
            "updatedAt": "2023-11-20T16:59:40.286Z",
            "valid": true,
            "value": "john.smith@example.com"
          }
        },
        "valid": true,
        "metadata": {},
        "config": {}
      }
    ],
    "versionId": "us_vr_YOUR_ID"
  }
}

Adds records to a workbook 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 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

400

Bad Request Error

404

Not Found Error

Authentication

Path parameters

Headers

Request

Response

Errors