Update sheet properties#

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#

Updates a sheet using the given sheet properties.

If the name property is set to null or not included in the request the sheet will not be renamed.

If both the parent_id and index properties are set to null or not included in the request the sheet will not be moved.

PUT /spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}

Required OAuth Scopes

data_tables|w

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	UpdateSheetBody	true	Properties for updating a sheet

Body parameter example#

{
  "index": 0,
  "name": "Data Sheet",
  "parent_id": "d10a604b74564afa86b5ba96755845652"
}

Code Samples#

curl

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

httpie

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

wget

wget --method=PUT "https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}" \
    --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.put('https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/{spreadsheetId}/sheets/{sheetId}', headers = headers)

print(r.json())