Reviews
Submit Decisions
Accept, reject or counter the counterparty’s tracked changes and produce your response draft.
Records your decision on each of the counterparty’s tracked changes, then writes them into a response draft. It works only on
counterparty_edits reviews. Each finding in such a review is one tracked change. Read them, with Wordsmith’s recommendation, through List Findings.
The response draft is a new DOCX:
- An accepted change is applied and no longer tracked.
- A rejected change is reverted.
- A countered change is reverted and replaced by your
counter_text, as a new tracked change. - A finding without a decision stays as the counterparty’s tracked change, for you to settle in Word.
Authentication
Requires an API key, or an OAuth token withreviews:write and files:read.
Path parameters
string
required
The id of a
counterparty_edits review. The review must be completed.Headers
string
A unique key for this request, such as a UUID. A repeat with the same key within 30 days returns the same operation and makes no second draft.
Body parameters
object[]
required
One entry per finding you are deciding. You can send decisions over several calls. A later decision on the same finding replaces the earlier one.
boolean
default:"true"
Produce the response draft from every decision recorded so far. With
false, the decisions are saved and no draft is made. The operation then comes back already succeeded, with file_id: null.integer
default:"0"
Seconds to wait for the draft before responding, from
0 to 20.string
An HTTPS URL that receives a signed
operation.succeeded, operation.failed or operation.cancelled event when the draft is ready.Response
Returns202 with an operation of type review_decisions. Its resource is the review. A repeat with the same Idempotency-Key returns 200 with the same operation.
When status is succeeded, result is { "file_id" }: the response draft. The review’s response_file_id is set to the same id, and each decided finding’s decision is filled in.