Make changes to documents

PATCH

/v1/documents/{slug}/versions/{version}/editor

const url = 'https://api.adversarial.com/api/v1/documents/cybergov/versions/2026.9.1/editor';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '[{"node_type":"selected_option","value":"example","node_id":"example"}]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.adversarial.com/api/v1/documents/cybergov/versions/2026.9.1/editor \
  --header 'Content-Type: application/json' \
  --data '[ { "node_type": "selected_option", "value": "example", "node_id": "example" } ]'

Accepts selected_option changes for switches and selectors, toggle_state changes for toggles, control_value changes for document-level controls, and table_rows snapshots for editable tables. A switch bound to a control takes no selection of its own: write the control with control_value and every switch and conditional block keyed on it follows. A selected_option change targeting a bound or locked switch is rejected.

Changes target the version named in the path, validated against that version’s template.

Parameters

Path Parameters

slug

required

string

The document slug

Example

cybergov

version

required

string

The document version

Example

2026.9.1

Request Body^required

application/json

Array

Defines some form of selection/edit that a user has made for a document item.

object

One of:

Contains the id of the selected option

object

node_type

required

string

Allowed values: selected_option

value

required

Contains the id of the selected option

string

Organization-authored content attached to a template section.

object

node_type

required

string

Allowed values: org_supplement

value

required

Organization-authored content attached to a template section.

object

body

required

Markdown source supplied by the organization.

string

deleted

required

Whether the supplement has been deleted.

boolean

enabled

required

Whether compiled readers include the supplement.

boolean

label

required

Short editor-facing title.

string

origin

required

Source of the supplement. Organization edits must use organization.

string

Allowed values: organization adversarial

section

required

Template section attachment key.

string

node_id

required

The id of the document item that was changed. this is the PK of the doc_item_reference table.

string

Responses

200

Documents updated

application/json

object

created

required

Who performed an action, and when.

object

One of:

null
string

null

date

required

string format: date-time

required

integer format: int32

proposal

required

integer format: int32

updated_date

string | null format: date-time

Example^generated

{
  "created": {
    "by": "example",
    "date": "2026-04-15T12:00:00Z"
  },
  "id": 1,
  "proposal": 1,
  "updated_date": "2026-04-15T12:00:00Z"
}

400

The version is archived or the changes are invalid

404

The organization cannot see this document version

Make changes to documents

Parameters

Path Parameters

Example

Example

Request Bodyrequired

Responses

200

Examplegenerated

400

404

Request Body^required

Example^generated