SMsmartsheet
folders

Move folder

Moves a folder.

post/folders/{folderId}/move

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_WORKSPACES

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

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

Result object containing a success message, result code, and metadata of the moved folder's new container.

message'SUCCESS'

Message that indicates the request was successful.

resultCode0
  • '0' Success

Example response

{
  "message": "SUCCESS"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.