Rename Worksheet
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API renames the specified Worksheet.
Method: POST
Request URL: {kyvos-url}/rest/v2/worksheets/{name-or-id}/rename
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the Login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Worksheet to be renamed. Note: If the Worksheet name is provided, then workbookName must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Worksheet name or Worksheet ID. If by=name, provide the Worksheet name in the name-or-id parameter. If by=id, provide the Worksheet ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If folderName is not provided, the Workbook is treated as a root-level entity by default. | – |
workbookName | String | Name of the Workbook in which the Worksheet to be renamed is present. | – |
targetName (Required) | String | New name for the Worksheet. | – |
Responses
200 Success
{
"code": 0,
"message": "Worksheet renamed successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |