Update a Hyperlink in an Excel Worksheet

This REST API updates a hyperlink in an Excel worksheet identified by its zero‑based index.

REST API

POST http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/hyperlinks/{hyperlinkIndex}

Request parameters

Parameter Name	Type	Location	Description
name	string	path	Name of the Excel file.
sheetName	string	path	Name of the worksheet.
hyperlinkIndex	integer	path	Zero‑based index of the hyperlink to be updated.
hyperlink	object	body	Hyperlink object that contains the new values for the hyperlink.
folder	string	query	Folder path where the workbook is stored.
storageName	string	query	Name of the storage service.

Request body schema – The hyperlink object may contain the following fields:

Field	Type	Required	Description
Address	string	yes	Target URL of the hyperlink.
Area	object	yes	Defines the cell range where the hyperlink is placed (`StartRow`, `StartColumn`, `EndRow`, `EndColumn`).
ScreenTip	string	no	Text displayed when the mouse hovers over the hyperlink.
TextToDisplay	string	no	Text shown in the cell for the hyperlink.
link	object	no	Hypermedia links (`Href`, `Rel`, `Title`, `Type`).

Error Responses

HTTP Code	Reason	Example Body
400	Bad Request – missing or invalid parameters.	`{ "Code":"400", "Message":"Invalid parameter value." }`
401	Unauthorized – missing or invalid JWT token.	`{ "Code":"401", "Message":"Access token is missing or invalid." }`
404	Not Found – workbook or worksheet does not exist.	`{ "Code":"404", "Message":"File not found." }`
500	Internal Server Error – unexpected server failure.	`{ "Code":"500", "Message":"An unexpected error occurred." }`

The OpenAPI Specification defines a publicly accessible programming interface and lets you perform REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make calls to the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/hyperlinks/1" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{
        "Hyperlink": {
          "Address": "https://www.msnbc.com/",
          "Area": {
            "StartRow": 1,
            "StartColumn": 6,
            "EndRow": 1,
            "EndColumn": 6
          },
          "ScreenTip": null,
          "TextToDisplay": "https://www.msnbc.com/",
          "link": {
            "Href": "/test.xlsx/worksheets/Sheet1/hyperlinks/4",
            "Rel": "self",
            "Title": null,
            "Type": null
          }
        },
        "Code": 200,
        "Status": "OK"
      }'

Response

{
  "Code": 200,
  "Status": "OK"
}

Cloud SDK Family

Using an SDK is the fastest way to develop. An SDK handles low‑level details, letting you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Add Hyperlink to Worksheet Clear Hyperlinks