Create Merge

Merge two or more revised copies of one base document into a single Word document.

Use this when several people have separately edited the same original document and the user wants one combined draft. The result carries each revision's edits as tracked changes, labeled by the revision they came from, so each edit can be accepted or rejected in Word. Each revision is diffed against the same base, so the result does not depend on their order: where revisions conflict, every edit appears as a tracked change attributed to its revision. Give each revision its author, the name its tracked changes are credited to. Propose the attribution from what is visible (document properties when readable, file names, the documents' own text), confirm it with the user, and ask when nothing gives a basis for a proposal. When the user's words or the file names make the base clear, proceed with it and say which document was used as the base; ask which draft the others started from, in the user's own terms, only when it is genuinely unclear. Never ask about merge order.

The merged document opens with a cover sheet on reviewing it and ends with a summary of each revision's changes; leave either out with include_cover_sheet or include_changes_summary false, as when the merged document replaces the user's own copy. Excel files are not supported.

Send a JSON body naming documents already in Version Story: original, and revisions, at least two, each a file {"file_id"} (upload a local file with POST /v1/files first) or a Document's version {"document_id", "version_id"}, and each revision with its author. The multipart/form-data upload of the documents' bytes (original, revisions and revision_authors fields) is deprecated: use the JSON body. The call answers at once with the merge_id GET /v1/merge/{merge_id} serves the merged document by.

post/v1/merge

Request

  • Base URL
    https://api.versionstory.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.versionstory.com/v1/merge
  • Auth
    HTTP bearer

Headers

X-Customer-Idstring nullable

Id of one of your customers (created in the developer dashboard) to attribute this request's credit usage to. Billing and limits stay organization-wide.

Request body

include_cover_sheetboolean

Whether the merged document opens with the cover sheet explaining how to review it.

include_changes_summaryboolean

Whether the merged document ends with the summary of each revision's changes.

Response

Successful Response

merge_idstring required

The merge's id (mrg_...), which GET /v1/merge/{merge_id} takes.

status'processing' required

Changes

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