Updates the settings and properties of an existing Smartsheet sheet. At least one of the optional input parameters must be specified.

Stored Procedure-Specific Information

At least one of the optional parameters: Name, 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 Id = '4146289590620036', Name = 'Q1 Project Plan', ProjectSettingsAggregate = '{"workingDays":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"lengthOfDay":7}', UserSettingsAggregate = '{"criticalPathEnabled":true,"displaySummaryTasks":false}';

Input

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

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the sheet was updated successfully.