Delete a single dataset#
Description#
Deletes the dataset for the specified sheet.
When you delete a dataset, you can select whether to leave its associated values in place. To delete its values, pass true for query parameter $deletevalues (default is false).
DELETE /spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset
Required OAuth Scopes
file:write
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-01-01) |
spreadsheetId |
path |
string |
true |
The unique identifier of the spreadsheet |
sheetId |
path |
string |
true |
The unique identifier of the sheet |
$deletevalues |
query |
boolean |
false |
Indicates whether values should be deleted along with the dataset |
Code Samples#
curl -X DELETE https://api.app.wdesk.com/spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-01-01'
http DELETE https://api.app.wdesk.com/spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset \
X-Version:2026-01-01 \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=DELETE "https://api.app.wdesk.com/spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset" \
--output-document - \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-01-01'
import requests
headers = {
'X-Version': '2026-01-01',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.app.wdesk.com/spreadsheets/{spreadsheetId}/sheets/{sheetId}/dataset', headers = headers)
print(r.headers['Location'])
Returns#
202 - Accepted#
Response body for asynchronous operations. Contains an operationLocation field that specifies the URL to poll for the operation result. This URL can also be found in the Location header on the response.
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. |
400 - Bad Request#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
403 - Forbidden#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
404 - Not Found#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
409 - Conflict#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
429 - Too Many Requests#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
500 - Internal Server Error#
Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Example Responses#
{
"operationLocation": "https://api.app.wdesk.com/operations/128f274395254cf17eda6b3eb3d021b9"
}
{
"code": "400BadRequest",
"message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
"code": "401Unauthorized",
"message": "No valid API token provided"
}
{
"code": "403Forbidden",
"message": "The API token does not have permissions to perform the request"
}
{
"code": "404NotFound",
"message": "The requested resource could not be found"
}
{
"code": "409Conflict",
"message": "The request conflicts with another request"
}
{
"code": "429TooManyRequests",
"message": "Too many requests have been made against the API in too short a time"
}
{
"code": "500InternalServerError",
"message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
"code": "503ServiceUnavailable",
"message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}