customXml.parts.patch

Replace the content and/or schemaRefs of an existing Custom XML Data Storage Part. At least one of content or schemaRefs is required. v1 partName targeting is limited to Word-style customXml/itemN.xml paths.

mutates documentdry runidempotent
doc.customXml.parts.patch(…)

Expected result

Returns a CustomXmlPartsMutationResult indicating success with the resolved target or a failure.

Inputs

targetid | partNamerequired
id
idstringrequired
partName
partNamestringrequired
contentstringconditionally required
schemaRefsstring[]conditionally required

Result

Output fields
true
successtruerequired
targetid | partNamerequired
id
idstringrequired
partName
partNamestringrequired
idstring
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • TARGET_NOT_FOUND
  • INVALID_INPUT

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