Document apiReferenceMetadata

metadata.update

Replace the JSON payload of an existing anchored-metadata entry. Replace semantics; no merge. The anchor is left untouched.

mutates documentdry runidempotent
doc.metadata.update(…)

Expected result

Returns an AnchoredMetadataMutationResult with the entry id on success or a failure.

Inputs

idstringrequired
payloadunknownrequired

Result

Output fields
true
successtruerequired
idstringrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
2 more codes
  • CAPABILITY_UNAVAILABLE
  • REVISION_MISMATCH

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