customXml.parts.remove

Remove a Custom XML Data Storage Part and clean up all linked package files (item, props, rels, content-types entry). v1 partName targeting is limited to Word-style customXml/itemN.xml paths.

mutates documentdry runnon-idempotent
doc.customXml.parts.remove(…)

Expected result

Returns a CustomXmlPartsMutationResult indicating success or a failure.

Inputs

targetid | partNamerequired
id
idstringrequired
partName
partNamestringrequired

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
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • TARGET_NOT_FOUND

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