Skip to content

Update a merge review

Platform module

PATCH/merge-reviews/{id}mergeReviews.update

A fuzzy duplicate awaiting review. Fuzzy matches never merge automatically. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability data.classification.write.
  • OAuth scopes: data.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

mergeReviews.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the merge review.

Request body: MergeReviewUpdate

mergeReviews.update: MergeReviewUpdate
FieldTypeRequiredDescription
decisionstring | nullNoReviewer decision. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
{
  "decision": "Merge"
}

Response 200: MergeReview

mergeReviews.update: MergeReview
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the merge review.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
similaritynumberYesSimilarity score, 0.85 or higher.
decisionstring | nullYesReviewer decision. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
import_row_result_idstring (uuid)YesIdentifier of the import row that matched.
candidate_tablestringYesTable of the existing row.Constraints: pattern ^[a-z][a-z0-9_]*$
candidate_idstring (uuid)YesIdentifier of the existing row it may duplicate.
decided_bystring (uuid) | nullYesIdentifier of the person who decided, set from the session.
decided_atstring (date-time) | nullYesWhen they decided, set by the database.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "similarity": 0.91,
  "decision": "Merge",
  "import_row_result_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "candidate_table": "records",
  "candidate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/merge-reviews/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"decision":"Merge"}'
const { data, etag } = await xos.mergeReviews.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "decision": "Merge"
  }, { ifMatch: etag });
response = xos.merge_reviews.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"decision": "Merge"}, if_match=etag)
xos merge-reviews update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"decision":"Merge"}' --if-match auto