Set a record's review status

View as Markdown

Sets the review status (pending/approved/rejected) across a record’s fields — by default the AI-written fields, or an explicit fieldKeys list. Requires data-record:review 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.
statusenumRequired
The review status to set across the fields.
Allowed values:
notestringOptional
An optional reviewer note.
fieldKeyslist of stringsOptional

Explicit field keys to review (defaults to the AI-written fields, else every field).

Response

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

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error