Document apiReferenceContent controls

contentControls.patch

Patch metadata properties on a content control (tag, alias, appearance, color, etc.).

mutates documentdry runconditional
doc.contentControls.patch(…)

Expected result

Returns a ContentControlMutationResult; reports NO_OP if no fields changed.

Inputs

targetobjectrequired
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired
8 additional input fields
aliasunknown
tagunknown
appearance"boundingBox" | "tags" | "hidden"
colorstring
placeholderstring
showingPlaceholderboolean
temporaryboolean
tabIndexinteger

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

Non-applied receipt codes

  • NO_OP

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