headerFooters.parts.delete

Delete a header/footer part and its associated relationship when no section slots reference it.

mutates documentdry runconditional
doc.headerFooters.parts.delete(…)

Expected result

Returns a HeaderFooterPartsMutationResult on success; INVALID_TARGET failure if sections still reference the part.

Inputs

targetobjectrequired
Fields
kind"headerFooterPart"required
refIdstringrequired

Result

Output fields
true
successtruerequired
refIdstringrequired
partPathstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET"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

  • INVALID_TARGET

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