Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Wrap an existing text range with a hyperlink.
  • Operation ID: hyperlinks.wrap
  • API member path: editor.doc.hyperlinks.wrap(...)
  • Mutates document: yes
  • Idempotency: conditional
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a HyperlinkMutationResult with the created hyperlink address on success, or a failure code on no-op.

​
Input fields

FieldTypeRequiredDescription
linkobjectyes
link.destinationobjectyes
link.destination.anchorstringno
link.destination.docLocationstringno
link.destination.hrefstringno
link.relstringno
link.targetstringno
link.tooltipstringno
targetTextAddressyesTextAddress
target.blockIdstringyes
target.kind"text"yesConstant: "text"
target.rangeRangeyesRange
target.range.endintegeryes
target.range.startintegeryes

​
Example request

{
  "link": {
    "destination": {
      "anchor": "example",
      "href": "example"
    },
    "target": "example",
    "tooltip": "example"
  },
  "target": {
    "blockId": "block-abc123",
    "kind": "text",
    "range": {
      "end": 10,
      "start": 0
    }
  }
}

​
Output fields

FieldTypeRequiredDescription
hyperlinkobject(kind=“inline”)yes
hyperlink.anchorInlineAnchoryesInlineAnchor
hyperlink.anchor.endPositionyesPosition
hyperlink.anchor.end.blockIdstringyes
hyperlink.anchor.end.offsetintegeryes
hyperlink.anchor.startPositionyesPosition
hyperlink.anchor.start.blockIdstringyes
hyperlink.anchor.start.offsetintegeryes
hyperlink.kind"inline"yesConstant: "inline"
hyperlink.nodeType"hyperlink"yesConstant: "hyperlink"
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codeenumyes"NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE"
failure.detailsobjectno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "hyperlink": {
    "anchor": {
      "end": {
        "blockId": "block-abc123",
        "offset": 0
      },
      "start": {
        "blockId": "block-abc123",
        "offset": 0
      }
    },
    "kind": "inline",
    "nodeType": "hyperlink"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET
  • INVALID_INPUT

​
Non-applied failure codes

  • NO_OP

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "link": {
      "additionalProperties": false,
      "properties": {
        "destination": {
          "additionalProperties": false,
          "properties": {
            "anchor": {
              "type": "string"
            },
            "docLocation": {
              "type": "string"
            },
            "href": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "rel": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "tooltip": {
          "type": "string"
        }
      },
      "required": [
        "destination"
      ],
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/TextAddress"
    }
  },
  "required": [
    "target",
    "link"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "hyperlink": {
          "additionalProperties": false,
          "properties": {
            "anchor": {
              "$ref": "#/$defs/InlineAnchor"
            },
            "kind": {
              "const": "inline"
            },
            "nodeType": {
              "const": "hyperlink"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "anchor"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "hyperlink"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "TARGET_NOT_FOUND",
                "CAPABILITY_UNAVAILABLE"
              ]
            },
            "details": {
              "type": "object"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "hyperlink": {
      "additionalProperties": false,
      "properties": {
        "anchor": {
          "$ref": "#/$defs/InlineAnchor"
        },
        "kind": {
          "const": "inline"
        },
        "nodeType": {
          "const": "hyperlink"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "anchor"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "hyperlink"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP",
            "INVALID_TARGET",
            "TARGET_NOT_FOUND",
            "CAPABILITY_UNAVAILABLE"
          ]
        },
        "details": {
          "type": "object"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}