Document apiReferenceProtection

protection.setEditingRestriction

Enable Word-style editing restriction on the document. Only readOnly mode is supported in v1.

mutates documentdry runidempotent
doc.protection.setEditingRestriction(…)

Expected result

Returns a ProtectionMutationResult with the updated protection state on success.

Inputs

mode"readOnly"required
1 additional input field
formattingRestrictedboolean

Result

Output fields

No fields.

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • NO_OP

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas