Move sheet

Moves the specified sheet to a new location. When a sheet that is shared to one or more users and/or groups is moved into or out of a workspace, those sheet-level shares are preserved.

post/sheets/{sheetId}/move

Request body

destinationIdnumber required

The ID of the destination container.

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

Type of destination container.

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

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"
}

Changes

No recorded changes to this endpoint across all 3 revisions of this API.