PUT /sheets/{sheetId}/summary/fields

Updates the summary fields for the given sheet.

Servers

https://api.smartsheet.com/2.0

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`renameIfConflict`	Boolean	No	Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending "(1)" or similar after the field name. Default value: false

renameIfConflict

Boolean

Set to true if you want to override the requirement for unique summary field names. Repeated names will be adjusted by appending "(1)" or similar after the field name.

Default value: false

Request body fields

Name	Type	Required	Description
`[]`	Array	Yes
`[].formula`	String	No	The formula for a cell, if set.
`[].locked`	Boolean	No	Indicates whether the field is locked.
`[].validation`	Boolean	No	Indicates whether summary field values are restricted to the type.
`[].image`		No
`[].contactOptions[]`	Array	No	Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.
`[].id`	Number	No	SummaryField Id.
`[].format`	String	No	The format descriptor. Only returned if the include query string parameter contains format and this column has a non-default format applied to it.
`[].symbol`	String	No	When applicable for PICKLIST column type.
`[].options[]`	Array	No	When applicable for PICKLIST column type. Array of the options available for the field.
`[].title`	String	No	Arbitrary name, must be unique within summary.
`[].type`	String	No	Possible values: `"CONTACT_LIST"` `"DURATION"` `"ABSTRACT_DATETIME"` `"DATE"` `"DATETIME"` `"PREDECESSOR"` `"PICKLIST"` `"MULTI_CONTACT_LIST"` `"MULTI_PICKLIST"` `"CHECKBOX"` `"TEXT_NUMBER"`
`[].hyperlink`		No
`[].index`	Number	No	Field index or position. This number is zero-based.
`[].objectValue`		No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.