sheets

Updates the sheet specified in the URL.

To modify sheet contents, see Add Rows, Update Rows, Add Columns, and Update Column.

This operation can be used to update an individual user's sheet settings. If the request body contains only the userSettings attribute, this operation may be performed even if the user only has read-only access to the sheet (for example, the user has viewer permissions or the sheet is read-only).

put/sheets/{sheetId}

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_SHEETS

Query parameters

accessApiLevelnumber

Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

Request body

dependenciesEnabledboolean

When set to true, enables Gantt/project dependencies on the sheet. Once enabled, the sheet supports Gantt view and its Start Date, End Date, Duration, % Complete, and Predecessor columns are linked by date arithmetic. Setting to false disables dependencies.

namestring

Sheet name.

Response

Returns Result object containing a Sheet object for the updated sheet.

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

Changes