Document apiReferenceSections

sections.setPageBorders

Set page border configuration for a section.

mutates documentdry runconditional
doc.sections.setPageBorders(…)

Expected result

Returns a SectionMutationResult receipt; reports NO_OP if page border configuration already matches.

Inputs

targetSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
bordersdisplay | offsetFrom | zOrder | top | right | bottom | leftrequired
display

No fields.

offsetFrom

No fields.

zOrder

No fields.

top

No fields.

right

No fields.

bottom

No fields.

left

No fields.

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