contentControls.group.wrap

Wrap a content control inside a new group content control. Always nests; not idempotent.

mutates documentdry runnon-idempotent
doc.contentControls.group.wrap(…)

Expected result

Returns a ContentControlMutationResult with the new group wrapper target.

Inputs

targetobjectrequired
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired

Result

Output fields
true
successtruerequired
contentControlobjectrequired
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired
updatedRefobject
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired
false
successfalserequired
failureReceiptFailurerequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • AMBIGUOUS_TARGET
4 more codes
  • INVALID_INPUT
  • LOCK_VIOLATION
  • REVISION_MISMATCH
  • 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