1Copy Workbook

1Copy Workbook

Overview

This API copies the Workbook to the specified target folder.

Method: POST

Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/copy


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

Header Name

Type

Description

Possible Values

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded


Path Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Workbook to be copied.

Note: If the Workbook name is provided, then sourceFolderName must also be provided.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as a Workbook name or Workbook ID.

If by=name, provide the Workbook name in the name-or-id parameter.

If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

sourceFolderName

String

Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root].

Note: If sourceFolderName is not provided, the Workbook will be treated as a root-level entity by default.

–

targetWorkbookName (Required)

String

New name to assign to the Workbook during the copy operation.

–

targetFolderName

String

Name of the folder where the Workbook will be be copied. If you want to copy the Workbook to the root directory, specify [Root].

Note: If neither targetFolderName nor targetFolderId is provided, the Workbook will be copied to the root directory by default.

–

targetFolderId

String

ID of the folder where the Workbook will be copied.

–


Responses

200 Success

{ "code": 0, "message": "Workbook copied successfully." }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error.


Copyright Kyvos, Inc. 2026. All rights reserved.