Document apiReferenceSections

sections.setPageMargins

Set page-edge margins for a section.

mutates documentdry runconditional
doc.sections.setPageMargins(…)

Expected result

Returns a SectionMutationResult receipt; reports NO_OP if margins already match the requested values.

Inputs

targetSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
topnumberconditionally required
rightnumberconditionally required
bottomnumberconditionally required
leftnumberconditionally required
gutternumberconditionally required

Result

Output fields
true
successtruerequired
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
2 more codes
  • CAPABILITY_UNAVAILABLE
  • INTERNAL_ERROR

Non-applied receipt codes

  • NO_OP
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

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