Update entity records
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Changes several records in one of the app's entities, each with its own fields, and returns the updated records in the order you sent them.
Send a JSON array of up to 500 objects. Each one carries the id of a record and the fields to change on it, and an id can appear only once. Like Update entity record, this merges rather than replaces, so a field you leave out keeps its value. Fields the entity's schema doesn't declare are left out of the record instead of failing the call.
Every record is checked before any is written. If one id matches no record the entity's rls update rule lets you change, or one record doesn't match the entity's schema or a field-level rule, the call is rejected and no records change.
Sending the same array again sets the same values, so a retry is safe. Unlike Update entity record, this doesn't trigger the app's webhooks, automations, or workflows.
<Note>This endpoint accepts a personal API key belonging to a user with access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>
Path parameters
ID of the app that owns the entity.
ID of the app that owns the entity.
Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.
Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.
Request body
Example request
[
{
"id": "6886b8d390dc7e2f4a2c91b3"
}
]Response
The updated records.
Example response
[
{
"id": "6886b8d390dc7e2f4a2c91b3",
"created_date": "2026-06-01T09:23:41.481000",
"updated_date": "2026-06-04T14:07:02.115000",
"created_by": "jane@acme.com",
"created_by_id": "6874b0c2e1a94d0031bb77de"
}
]Changes
Changed in 1 of the 33 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○