Apply a human-selected Compare decision

Used only by the human review workspace after a person selects a decision. action=pull_to_base adds selected changes to the version identified by base_document_id. action=revert_in_compare removes selected changes from the version identified by compare_document_id. Omit difference_ids to apply to all unresolved differences.

POST /documents/compare/apply

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

compare_id string
Durable compare session id. Preferred for multi-step workflows.
base_document_id string
Document/version id where changes should be added. Required only when compare_id is omitted.
compare_document_id string
Document/version id that contains the changes. Required only when compare_id is omitted.
action string Required
One of pull_to_base revert_in_compare
difference_ids string[]
Difference ids to apply. Omit or pass [] to apply all unresolved differences.

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/documents/compare/apply" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"action":"pull_to_base"}'

const response = await fetch("https://api.scaffoldyourdocs.com/documents/compare/apply", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"action":"pull_to_base"})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/documents/compare/apply",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"action": "pull_to_base"},
)