Set a field's review status

View as Markdown

Sets the review status (pending/approved/rejected) of a single field on a record. Approved/rejected fields are locked from edits. 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.
fieldKeystringRequired
The field key on the object definition.

Request

This endpoint expects an object.
statusenumRequired
The review status to set on the field.
Allowed values:
notestringOptional
An optional reviewer note.

Response

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

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error