headerFooters.parts.create

Create a new independent header/footer part, optionally cloned from an existing part.

mutates documentdry runnon-idempotent
doc.headerFooters.parts.create(…)

Expected result

Returns a HeaderFooterPartsMutationResult with the new refId/partPath on success, INVALID_TARGET failure when sourceRefId is invalid or mismatched.

Inputs

kind"header" | "footer"required
1 additional input field
sourceRefIdstring

Result

Output fields
true
successtruerequired
refIdstringrequired
partPathstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
1 more codes
  • 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