Skip to main content
POST
Preview publishing the draft

Authorizations

x-api-key
string
header
required

Body

application/json
policy_definition
object | null

Unsaved edits to the draft, in the shape PUT /policy_version takes. Omit to preview the saved draft.

Response

OK

active_policy_definition
object | null
required
active_version
integer | null
required

Null when no version is active

changed_section_heron_ids
string[]
required

Sections added, removed or with a changed check

draft_revision
string | null
required

Send it to POST /policy_version/publish as expected_draft_revision. Null when previewing unsaved edits: save them, then use the draft_revision PUT /policy_version returns.

draft_version
integer | null
required

Null when previewing edits before a draft exists

has_rule_changes
boolean
required
issues
object[]
required

What publishing would break; an issue with blocks_publish set stops the publish

policy_definition
object
required

The draft as publishing would put it live

table_changes
object[]
required

Lookup tables the draft adds, drops or uses another version of

tables_revision
string
required

Send it to POST /policy_version/publish as expected_tables_revision, so a lookup table edited after this preview, even before the draft is saved, refuses the publish