Copy sheet

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description#

Asynchronously copies a sheet given details about the copy’s destination within the same or another spreadsheet. Options are specified using a SheetCopy object.

This endpoint copies a sheet’s content, but does not copy labels, comments, or tasks. It will copy over most formatting, however it does not copy user-defined style guides across spreadsheets. So if the source sheet has formatting that depends on a user-defined style guide, that formatting will be lost when copying to a new spreadsheet.

Unless otherwise specified, the copy appears at the top level of its destination spreadsheet, with an index of 0, and with the same name as the original sheet.

POST /platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
spreadsheetId	path	string	true	The unique identifier of the spreadsheet
sheetId	path	string	true	The unique identifier of the sheet
body	body	SheetCopy	true	A SheetCopy object

Body parameter example#

{
  "sheetIndex": 2,
  "sheetName": "Q1",
  "sheetParent": "5bbf8aa3cea54465762af96e3ca411c7",
  "spreadsheet": "c65d9572a7464037a383d6235633cf74"
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy', headers = headers)

print(r.headers['Location'])