Reviews

Update review payload (new version)

Used when a reviewer requested changes and the agent resubmits. Pass the version that's being updated — stale versions are rejected.

put/api/v1/reviews/{id}

Request

Base URL: https://api.gatewerk.com
URL: https://api.gatewerk.com/api/v1/reviews/{id}
Auth: HTTP bearer

Request body

payloadJsonObject required

Free-form JSON object.

versioninteger required

Response

Updated review

object'review' required

idstring required

project_idstring required

template_idstring nullable

template_slugstring required

payloadJsonObject required

Free-form JSON object.

suggested_valueJsonObject

Free-form JSON object.

approved_valueJsonObject

Free-form JSON object.

edited_payloadJsonObject

Free-form JSON object.

callback_urlstring nullable

priority'low' | 'normal' | 'high' | 'critical' required

status'pending' | 'awaiting_iteration' | 'decided' | 'expired' | 'archived' required

Canonical review status. Wire-format output is always one of these five values. Query-param status filter additionally accepts the legacy 'changes_requested' alias as a deprecated input for one minor version per spec §11.3 — removed in v2.0.

decision'approved' | 'rejected' | 'edited' | 'retried' | 'expired'

feedbackstring nullable

decided_bystring nullable

decided_by_verifiedboolean nullable

Whether decided_by names a confirmed identity. False only for a decision made through a PUBLIC review link, where the decider is the recipient_label the sharer typed and nothing verified it. Null for reviews decided before this field existed: render no claim rather than assuming unverified.

decided_atstring date-time nullable

current_versioninteger required

assigneestring nullable

metadataJsonObject

Free-form JSON object.

action_valuestring nullable

action_labelstring nullable

created_atstring date-time required

updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.