Document apiReferenceHyperlinks

hyperlinks.patch

Update hyperlink metadata (destination, tooltip, target, rel) without changing display text.

mutates documentdry runconditional
doc.hyperlinks.patch(…)

Expected result

Returns a HyperlinkMutationResult with the updated hyperlink address on success, or NO_OP if unchanged.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
patchobjectrequired
Fields
hrefstring | null
Variant 1

No fields.

Variant 2

No fields.

anchorstring | null
Variant 1

No fields.

Variant 2

No fields.

docLocationstring | null
Variant 1

No fields.

Variant 2

No fields.

tooltipstring | null
Variant 1

No fields.

Variant 2

No fields.

targetstring | null
Variant 1

No fields.

Variant 2

No fields.

relstring | null
Variant 1

No fields.

Variant 2

No fields.

Result

Output fields
true
successtruerequired
hyperlinkobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsobject

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET
1 more codes
  • INVALID_INPUT

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