VocalDocscontracts 1.65.0

PolicyUpdateRequest

Replaces the named fields of the draft at the revision If-Match names; the revision advances by one and the document is linted again with the hook, action type and tag it then has. Disabling a compliance-tagged Policy, and any write to an organization-scoped one, need policies:admin.

An object with 9 fields.

Fields

FieldTypeRequiredDescription
action_typePolicyActionTypeno
compliance_tagComplianceTag or nullno
descriptionstring or nullnoFor reviewers; never sent to the model.
enabledbooleanno
hookHookPointno
logicJdmDocumentInputnoReplaces the whole document. The JDM document under the Vocal profile: its input is the hook's Call context and it writes the parameters of the action type under action, or nothing. Every save and publish lints it (policyLint); an error refuses with 422 validation_failed.
namePolicyNameno
priorityintegerno
scopePolicyScopeno

Used by

The operations whose parameters, request body or responses name this shape directly.