Updates the settings and properties of a sheet in your Smartsheet account. At least one of the optional inputs must be specified.

Procedure Specific Information

At least one of the optional parameters: SheetName, UserSettingsAggregate, or ProjectSettingsAggregate; must be specified.

For the correct value format for the UserSettingsAggregate and ProjectSettingsAggregate input parameters refer to Smartsheet's API Documentation.

Examples

For examples on how to use this stored procedure, refer to the following queries:

EXECUTE UpdateSheet SheetId = '4146289590620036', SheetName = 'Q1 Project Plan', ProjectSettingsAggregate = '{"workingDays":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"lengthOfDay":7}', UserSettingsAggregate = '{"criticalPathEnabled":true,"displaySummaryTasks":false}';

Input

Name	Type	Required	Description
SheetId	String	True	The unique identifier of the sheet to be updated.
SheetName	String	False	The new name for the sheet.
UserSettingsAggregate	String	False	A JSON object representing user-level sheet settings to update.
ProjectSettingsAggregate	String	False	A JSON object representing project-level settings to update.

Result Set Columns

Name	Type	Description
Success	Boolean	A boolean indicating whether the sheet was updated successfully.