SMsmartsheet
dashboards

Move dashboard

Moves the specified dashboard to a new location.

post/sights/{sightId}/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: CREATE_SIGHTS

Path parameters

sightIdstring required

ID of the dashboard (sight) being accessed.

Headers

Authorizationstring

API Access Token used to authenticate requests to Smartsheet APIs.

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 Dashboard object with a subset of attributes for the moved dashboard.

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.