SMsmartsheet
dashboards

Update dashboard

Changed on

Updates (renames) the specified dashboard.

put/sights/{sightId}

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_SIGHTS

Query parameters

numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

Headers

Content-Typestring

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

Request body

namestring

Dashboard name.

Response

Result object containing the updated Dashboard object.

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

  • 5fecdbbecd34Revision changes
    • info

      the response optional property ///////// became write-only for the status

    • info

      the response optional property ///////// became write-only for the status

  • 636ac6da2c11Revision changes
    • info

      added the optional property // to the response with the status