Skip to navigation

Review a single object field

View as Markdown

Sets the review status of one field (:fieldKey) on an object. Authorization: requires space:contribute on :spaceId — lacking it gives 403 (no space:read → 404). Body: { status, note? } where status is pending|approved|rejected; approved/rejected review-locks the field against edits, pending dismisses the lock. Archived fields are still reviewable. Unknown field key → 404, invalid status → 422 invalid_status. Returns the updated { object }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired
definitionIdstringRequired
objectIdstringRequired
fieldKeystringRequired

Request

This endpoint expects an object.
statusenumRequired
Allowed values:
notestringOptional

Response

The object with the field's review state updated.
objectobject

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error