Sign in
latestOpenAPI 3.0.32026-08-151874701.5 MB

5dedc4bd492c

sheets

Copy sheet

Creates a copy of the specified sheet.

post/sheets/{sheetId}/copy

Request body

destinationIdnumber required

The ID of the destination container.

destinationType'folder' | 'home' | 'workspace' nullable

Type of destination container.

The "home" enum is Deprecated since March 25, 2025, and will be removed.

newNamestring

Name of the newly created object (when copying a dashboard, folder, or sheet).

Response

SUCCESS

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation
versionnumber nullable

New version of the sheet. Applicable only for operations which update sheet data.

Example response

{
  "message": "SUCCESS"
}