Update a record

View as Markdown

Partially merges field values into a record (and optionally clears fields via unset), re-validating only the touched fields. Rejects writes to review-locked fields (409) and enforces unique fields. Requires data-record:write on the project.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired
The parent project id.
objectIdstringRequired

The project-scoped object definition id.

recordIdstringRequired
The record id.

Request

This endpoint expects an object.
datamap from strings to anyRequired
Field values to merge, keyed by field key.
unsetlist of stringsOptional

Optional field keys to clear (blank).

Response

The updated record.
recordmap from strings to any
An arbitrary JSON object.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error