Creating records with the FileMaker Data API

Intermediate

Learn how to create a new record in a FileMaker layout via the Data API — including how to set field values, handle the response, and get the new record ID.

What you'll learn

The correct endpoint and request body format for creating a record
How to set field values and portal rows in the same request
How to read the new record ID from the response

Creating a record via the Data API is a POST request to the /records endpoint for a specific layout. The layout you use determines which fields are accessible. The response gives you the internal record ID of the newly created record.

1/3

The create record endpoint

POST to /fmi/data/v1/databases/{db}/layouts/{layout}/records with a JSON body containing the field data.

JSON

// POST /fmi/data/v1/databases/MyDB/layouts/Customers/records
// Authorization: Bearer {token}
// Content-Type: application/json

{
  "fieldData": {
    "Name": "Acme Corp",
    "Email": "hello@acme.com",
    "Status": "Active"
  }
}

FileMaker Data API authentication and session tokens Running a FileMaker script via the Data API