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.
Copies only the sheets's content — not any labels, comments, tasks, or formatting from a style guide. 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 /spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy
Required OAuth Scopes:
file:write
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| 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 -X POST https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy \
Content-Type:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copy" \
--output-document - \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'
import requests
headers = {
'Content-Type': '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.json())
Returns
202 - Accepted
| Header | Description |
|---|---|
| Location | The location to poll for the operation result. |
| Retry-After | The number of seconds to wait before polling for a result and between polling attempts. |