home

Create folder

Creates a new folder.

DEPRECATED - This endpoint is being removed. To adapt to this change, please see Migrate from using the Sheets folder.

post/home/folders

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

idnumber

Folder ID.

favoriteboolean

Deprecated Returned only if the user has marked the folder as a favorite in their "Home" tab (value = true).

foldersFolder[] circular
namestring

Folder name.

permalinkstring

URL that represents a direct link to the folder in Smartsheet.

Response

Result object containing a Folder object for newly created folder.

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

Example response

{
  "message": "SUCCESS"
}

Changes

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